PingSite

List all ping sites

Get all available ping site

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

OK

application/json

continentIdinteger · integerRequired

The ID of the continent

continentNamestringRequired

The name of the continent

countryIdinteger · integerRequired

The ID of the country

countrystringRequired

The name of the country

dcLocationIdinteger · integerRequired

The ID of the data center. Find all possible values from GET /cloud/dcLocation

dcLocationNamestringRequired

The name of the data center. Find all possible values from GET /cloud/dcLocation

hostnamestringRead-onlyRequired

The host name of the ping server in this data center

ipv4string[]Read-onlyRequiredDeprecated

List of ip address of ip version 4

ipv6string[]Read-onlyRequiredDeprecated

List of ip address of ip version 6

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/pingsite

HTTPcURLJavaScriptPython

GET /v3/pingsite HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "continentId": 1,
    "continentName": "text",
    "countryId": 1,
    "country": "text",
    "dcLocationId": 1,
    "dcLocationName": "text",
    "hostname": "text"
  }
]

Get all available ping site its detail beacon information

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

OK

application/json

continentIdinteger · integerRead-onlyRequired

The ID of the continent

continentNamestringRead-onlyRequired

The name of the continent

countryIdinteger · integerRead-onlyRequired

The ID of the country

countryNamestringRead-onlyRequired

The name of the country

dcLocationIdinteger · integerRead-onlyRequired

The ID of the data center. Find all possible values from GET /cloud/dcLocation

dcLocationNamestringRead-onlyRequired

The name of the data center. Find all possible values from GET /cloud/dcLocation

regionNamestringRead-onlyRequired

The region name of the ping server in this data center

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/pingsite/detail

HTTPcURLJavaScriptPython

GET /v3/pingsite/detail HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "continentId": 1,
    "continentName": "text",
    "countryId": 1,
    "countryName": "text",
    "dcLocationId": 1,
    "dcLocationName": "text",
    "regionName": "text",
    "beacons": [
      {
        "hostName": "text",
        "state": "text",
        "ip": "text"
      }
    ]
  }
]

Get all available ping site latency

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

authStatusbooleanRequired

authservicebooleanRequired

authuserbooleanRequired

responseTimenumber · floatRequired

statusstringRequired

serverTimestringRequired

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/pingsite/latency

HTTPcURLJavaScriptPython

GET /v3/pingsite/latency HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "authStatus": true,
    "authservice": true,
    "authuser": true,
    "responseTime": 1,
    "status": "text",
    "response": {
      "rpmRaw": [
        {
          "link": "text",
          "latency5m": "text",
          "latency1d": "text",
          "latency1w": "text",
          "latency30d": "text",
          "jitter": "text",
          "packetloss5m": "text",
          "packetloss1d": "text",
          "packetloss1w": "text",
          "packetloss30d": "text",
          "sourceRegion": true,
          "source": {
            "lat": "text",
            "lng": "text"
          },
          "destinationRegion": true,
          "destination": {
            "lat": "text",
            "lng": "text"
          }
        }
      ],
      "features": {
        "ok": [
          {
            "type": "text",
            "properties": {
              "link": "text",
              "description": "text"
            },
            "geometry": {
              "type": "text",
              "coordinates": [
                [
                  1
                ]
              ]
            }
          }
        ],
        "down": [
          {
            "type": "text",
            "properties": {
              "link": "text",
              "description": "text"
            },
            "geometry": {
              "type": "text",
              "coordinates": [
                [
                  1
                ]
              ]
            }
          }
        ],
        "loss": [
          {
            "type": "text",
            "properties": {
              "link": "text",
              "description": "text"
            },
            "geometry": {
              "type": "text",
              "coordinates": [
                [
                  1
                ]
              ]
            }
          }
        ]
      },
      "routerPoints": [
        {
          "type": "text",
          "properties": {
            "link": "text",
            "description": "text"
          },
          "geometry": {
            "type": "text",
            "coordinates": [
              1
            ]
          }
        }
      ]
    },
    "serverTime": "text"
  }
]