POST /measurements/
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/
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
api-key
Type
API Key (header: Authorization)
or
session
Type
API Key (cookie: atlasess)
Request Body
Request Body
bill_to
string
The cost of these measurements is deducted from the user in this field. The default is the creator of the measurement
Format
"email"is_oneoff
boolean
Flag indicating that all measurements in the definitions object should be one-off measurements
start_time
string
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"stop_time
string
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.
Collapse
is_public
boolean
Indicates this measurement is publicly available. This may be changed from false to true, but not from true to false
Default
truedescription
string
Required
User-defined description of the measurement
auto_topup
boolean
Automatic top-up measurements probes
Default
falseauto_topup_prb_days_off
integer
The number of days after which disconnected probes should be replaced in a measurement
Maximum
30Minimum
1Default
7auto_topup_prb_similarity
number
Minimum similarity level for replacement probes
Format
"double"Maximum
1Minimum
0Default
0.5target_update_hours
integer
The number of hours after which the DNS record of the target should be looked up again
Default
0group_id
integer
The ID of the measurement group. This ID refers to a measurement acting as group master
af
integer
Required
Address family of the measurement (IPv4 of IPv6)
4- 46- 6
Valid values
46is_oneoff
boolean
Indicates this is a one-off measurement
spread
integer
Distribution of probes' measurements throughout the interval (default is half the interval)
resolve_on_probe
boolean
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
Default
falseskip_dns_check
boolean
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.
start_time
string
Configured start time (as a unix timestamp)
Format
"date-time"stop_time
string
Actual end time of measurement (as a unix timestamp)
Format
"date-time"tags
string[]
Array of tags to apply to the measurement
type
string
Required
ping- Pingtraceroute- Traceroutedns- DNSsslcert- TLShttp- HTTPntp- NTP
Valid values
"ping""traceroute""dns""sslcert""http""ntp"target
string
Required
The FQDN (if it was requested) or the ip address of the target of this measurement
interval
integer
Interval between samples from a single probe.
packets
integer
The number of packets send in a measurement execution. Value must be between 1 and 16. Default is 3
Maximum
16Minimum
1Default
3size
integer
size of the data part of the packet, i.e. excluding any IP and ICMP headers. Value must be between 1 and 2048
Maximum
2048Minimum
1Default
64packet_interval
integer
Time between packets in milliseconds. Value must be between 2 and 300000
Maximum
30000Minimum
2Default
1000include_probe_id
boolean
Include the probe ID (encoded as ASCII digits) as part of the payload
Default
falseResponses
Responses
application/json
object
measurements
integer[]
Required
IDs of the created measurements.