PATCH /measurements/{msm}/

Update an existing measurement.

PATCH /measurements/{msm}/ — fields

Comma-separated list of fields to include in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.

PATCH /measurements/{msm}/ — format[datetime]

Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix' or 'timestamp')

PATCH /measurements/{msm}/ — msm

The unique measurement ID.

PATCH /measurements/{msm}/ — optional_fields

Comma-separated list of optional fields named to include in response objects.

PATCH /api/v2/measurements/{msm}/

Update an existing measurement.

Try it out

Playground

Authorization

api-key

Variables

Key

Value

msm*

fields

format[datetime]

optional_fields

Body

Authorizations

Authorizations

api-key

Type

API Key (header: Authorization)

or

session

Type

API Key (cookie: atlasess)

Parameters

Path Parameters

msm*

The unique measurement ID.

Type

integer

Required

Query Parameters

fields

Comma-separated list of fields to include in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.

Type

string

format[datetime]

Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix' or 'timestamp')

Type

string

Valid values

"iso-8601""json""timestamp""unix"

optional_fields

Comma-separated list of optional fields named to include in response objects.

Type

string

Valid values

"participation_requests""participant_logs""current_probes""is_active""probe_sources""probes"

Request Body

Request Body

object

The fields that can be changed by the user after creation.

This is an interface that is used by both CoreMeasurementSerialiser and
MeasurementUpdateSerializer.

Indicates this measurement is publicly available. This may be changed from false to true, but not from true to false

Defaulttrue

User-defined description of the measurement

Automatic top-up measurements probes

Defaultfalse

The number of days after which disconnected probes should be replaced in a measurement

Maximum30

Minimum1

Default7

Minimum similarity level for replacement probes

Format"double"

Maximum1

Minimum0

Default0.5

The number of hours after which the DNS record of the target should be looked up again

Default0