Util

Lists fields that can be used in other calls

get

Lists fields that can be used in other calls

Authorizations

OAuth2Application

OAuth2applicationRequired

Token URL:

Responses

200

OK

application/json

string[]Optional

503

Service Unavailable

application/json

get

/util/fields

HTTPcURLJavaScriptPython

GET /api/util/fields HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  "text"
]

GetHosts

get

Lists all public facing CDN IPs

Responses

200

OK

application/json

503

Service Unavailable

application/json

get

/util/hosts

HTTPcURLJavaScriptPython

GET /api/util/hosts HTTP/1.1
Accept: */*

{
  "hosts": [
    {
      "ipv4": "5.200.5.200",
      "ipv6": "",
      "location": "usqas1",
      "type": "edge"
    }
  ]
}

Health Check

get

Will reply with Pong if service is ready to handle requests

Responses

200

OK

application/json

databasestringOptionalExample: database message

esstringOptionalExample: es message

hostnamestringOptionalExample: server123

ipstringOptionalExample: 192.0.2.2

namestringOptionalExample: pong

versionstringOptionalExample: 0.21-1111

503

Service Unavailable

application/json

get

/util/ping

HTTPcURLJavaScriptPython

GET /api/util/ping HTTP/1.1
Accept: */*

{
  "database": "database message",
  "es": "es message",
  "hostname": "server123",
  "ip": "192.0.2.2",
  "name": "pong",
  "version": " 0.21-1111"
}

WhoAmI

get

Information about current user

Authorizations

OAuth2Application

OAuth2applicationRequired

Token URL:

Responses

200

OK

application/json

client_idstringOptionalExample: account name

emailstringOptionalExample: [email protected]

expnumberOptionalExample: 1665151134

iatnumberOptionalExample: 1665147534

isStaffAccountstringOptionalExample: True

jtistringOptionalExample: bZzNlATzvozLZ4o7naNQTeO4fzPVEIC8kNTYdorqWGDQZeDhLDdk7

organizationIdstringOptionalExample: 12312313f-asdasdsad-fasdadasd

401

Unauthorized

application/json

get

/util/whoami

HTTPcURLJavaScriptPython

GET /api/util/whoami HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "client_id": "account name",
  "email": "[email protected]",
  "exp": 1665151134,
  "iat": 1665147534,
  "isStaffAccount": "True",
  "jti": "bZzNlATzvozLZ4o7naNQTeO4fzPVEIC8kNTYdorqWGDQZeDhLDdk7",
  "organizationId": "12312313f-asdasdsad-fasdadasd",
  "services": {
    "ANY_ADDITIONAL_PROPERTY": {
      "capabilities": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "projectName": "text",
      "serviceId": "text",
      "serviceType": "text",
      "vhost": {
        "BillingTemplateId": 12314,
        "clientId": "12345",
        "dns": "cdn.i3d.net",
        "enabled": true,
        "hash": "JJUSMXH",
        "name": "VHost name",
        "originId": 12314,
        "path": "/o1/cdn"
      }
    }
  }
}