Skip to content

POST /measurements/my/

Create one or more measurements of any available type. See the Measurements section of the REST API Manual for detailed instructions on creating measurements.

POST /api/v2/measurements/my/

Create one or more measurements of any available type. See the Measurements section of the REST API Manual for detailed instructions on creating measurements.

Try it out

Playground

Authorization
Body
Authorizations

Authorizations

api-key
Type
API Key (header: Authorization)
or
session
Type
API Key (cookie: atlasess)
Request Body

Request Body

object

The cost of these measurements is deducted from the user in this field. The default is the creator of the measurement

Format"email"

Flag indicating that all measurements in the definitions object should be one-off measurements

Configured start time for all measurements in the definitions section as either an unix timestamp or as a ISO-8601/ECMA-262 javascript datetime.

Format"date-time"

Configured stop time for all measurements in the definitions section as either an unix timestamp or as a ISO-8601/ECMA-262 javascript datetime.

Format"date-time"
object

Output serializer fields in lexically sorted order.

This shouldn't make a difference to machines since JSON object keys are
unordered, but it makes the output easier to read and compare for humans.

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

The ID of the measurement group. This ID refers to a measurement acting as group master

Address family of the measurement (IPv4 of IPv6)

  • 4 - 4
  • 6 - 6
Valid values46

Indicates this is a one-off measurement

Distribution of probes' measurements throughout the interval (default is half the interval)

Indicates that a name should be resolved (using DNS) on the probe. If set to false then the name will be resolved centrally, on the RIPE Atlas servers

Defaultfalse

Indicates that the target DNS name shold not be verified at the time of measurement creation.This is useful if the name is expected to not resolve at that time.

Configured start time (as a unix timestamp)

Format"date-time"

Actual end time of measurement (as a unix timestamp)

Format"date-time"

Array of tags to apply to the measurement

  • ping - Ping
  • traceroute - Traceroute
  • dns - DNS
  • sslcert - TLS
  • http - HTTP
  • ntp - NTP
Valid values"ping""traceroute""dns""sslcert""http""ntp"

The FQDN (if it was requested) or the ip address of the target of this measurement

Interval between samples from a single probe.

The number of packets send in a measurement execution. Value must be between 1 and 16. Default is 3

Maximum16
Minimum1
Default3

size of the data part of the packet, i.e. excluding any IP and ICMP headers. Value must be between 1 and 2048

Maximum2048
Minimum1
Default64

Time between packets in milliseconds. Value must be between 2 and 300000

Maximum30000
Minimum2
Default1000

Include the probe ID (encoded as ASCII digits) as part of the payload

Defaultfalse
Responses

Responses

application/json
object

IDs of the created measurements.

Samples