HostTelemetry

Host telemetry requests

Get memory telemetry for the given host (default = last 24 hours)

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostIdintegerRequired

Query parameters

startTimeintegerOptional

Start unix timestamp

endTimeintegerOptional

End unix timestamp

Responses

200

OK

application/json

unitstringRead-onlyRequired

Unit of data frequency, which is always '1m' in this endpoint

memMaxinteger · integerRead-onlyRequired

The amount of memory that is available on the host (in megabytes)

404

Error Host not found

500

Internal Server Error

application/json

get

/v3/telemetry/host/{hostId}/memory

HTTPcURLJavaScriptPython

GET /v3/telemetry/host/{hostId}/memory HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "unit": "text",
    "memMax": 1,
    "data": [
      {
        "timestamp": 1,
        "memUsed": 1
      }
    ]
  }
]

Get cpu telemetry for the given host (default = last 24 hours)

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostIdintegerRequired

Query parameters

startTimeintegerOptional

Start unix timestamp

endTimeintegerOptional

End unix timestamp

Responses

200

OK

application/json

unitstringRead-onlyRequired

Unit of data frequency, which is always '1m' in this endpoint

404

Error Host not found

500

Internal Server Error

application/json

get

/v3/telemetry/host/{hostId}/cpu

HTTPcURLJavaScriptPython

GET /v3/telemetry/host/{hostId}/cpu HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "unit": "text",
    "data": [
      {
        "timestamp": 1,
        "cpu": 1
      }
    ]
  }
]

Get network telemetry for the given host (default = last 24 hours)

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostIdintegerRequired

Query parameters

startTimeintegerOptional

Start unix timestamp

endTimeintegerOptional

End unix timestamp

Responses

200

OK

application/json

unitstringRead-onlyRequired

Unit of data frequency, which is always '1m' in this endpoint

404

Error Host not found

500

Internal Server Error

application/json

get

/v3/telemetry/host/{hostId}/network

HTTPcURLJavaScriptPython

GET /v3/telemetry/host/{hostId}/network HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "unit": "text",
    "data": [
      {
        "timestamp": 1,
        "networkIngress": 1,
        "networkEgress": 1
      }
    ]
  }
]

Get hard disk telemetry for the given host (default = last 24 hours)

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostIdintegerRequired

Query parameters

startTimeintegerOptional

Start unix timestamp

endTimeintegerOptional

End unix timestamp

Responses

200

OK

application/json

unitstringRead-onlyRequired

Unit of data frequency, which is always '1m' in this endpoint

404

Error Host not found

500

Internal Server Error

application/json

get

/v3/telemetry/host/{hostId}/hdd

HTTPcURLJavaScriptPython

GET /v3/telemetry/host/{hostId}/hdd HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "unit": "text",
    "data": [
      {
        "timestamp": 1,
        "hardDisk0Free": 1,
        "hardDisk1Free": 1,
        "hardDisk2Free": 1,
        "hardDisk3Free": 1
      }
    ]
  }
]

Get the telemetry for all hosts across all providers at the current point in time

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Query parameters

filterstringOptional

You can filter based on following parameters

• deploymentEnvironmentId
• fleetId
• deploymentRegionId
• dcLocationId

Responses

200

OK

application/json

unitstringRead-onlyRequired

Unit of data frequency, which is always '1m' in this endpoint

400

Bad Request

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/host/utilization

HTTPcURLJavaScriptPython

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

[
  {
    "unit": "text",
    "data": [
      {
        "timestamp": 1,
        "hostsOccupied": 1,
        "hostsFree": 1,
        "hostsFull": 1,
        "hostsTotal": 1,
        "launched": 1,
        "destroyed": 1
      }
    ]
  }
]

Get the average of server host status telemetry

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Query parameters

filterstringOptional

You can filter based on following parameters

• deploymentEnvironmentId
• fleetId
• deploymentRegionId
• dcLocationId

startTimeintegerOptional

Unix timestamp. Filter from time, default value is -1 day

endTimeintegerOptional

Unix timestamp. Filter to time, default value is now

Responses

200

OK

application/json

unitstringRead-onlyRequired

Unit of data frequency, possible interval options are as follows

• minute
• hour
• day
• month

400

Bad Request

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/host/utilization/aggregate

HTTPcURLJavaScriptPython

GET /v3/telemetry/host/utilization/aggregate HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

{
  "unit": "text",
  "data": [
    {
      "timestamp": 1,
      "hosts": [
        {
          "providerId": 1,
          "hostsOccupied": 1,
          "hostsFree": 1,
          "hostsFull": 1,
          "hostsTotal": 1,
          "launched": 1,
          "destroyed": 1
        }
      ]
    }
  ]
}

List the historical data of hardware capacity of all your Hosts

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Query parameters

filterstringOptional

You can filter based on following parameters

• deploymentEnvironmentId
• fleetId

startTimeintegerOptional

Unix timestamp. Filter from time, default value is -1 day

endTimeintegerOptional

Unix timestamp. Filter to time, default value is now

Responses

200

OK

application/json

unitstringRead-onlyRequired

Unit of data frequency

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/host/hardwareCapacity

HTTPcURLJavaScriptPython

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

[
  {
    "unit": "text",
    "data": [
      {
        "timestamp": 1,
        "value": {
          "cpuPercentage": 1,
          "ramPercentage": 1,
          "diskPercentage": 1
        }
      }
    ]
  }
]

List the current hardware capacity of all your Hosts

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Query parameters

filterstringOptional

You can filter based on following parameters

• deploymentEnvironmentId
• fleetId

Responses

200

OK

application/json

cpuPercentagenumber · floatRead-onlyRequired

The amount of used CPU power as a percentage of the total amount of CPU power

ramPercentagenumber · floatRead-onlyRequired

The amount of used RAM space as a percentage of the total amount of RAM

diskPercentagenumber · floatRead-onlyRequired

The amount of used disk space as a percentage of the total amount of space

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/host/hardwareCapacity/current

HTTPcURLJavaScriptPython

GET /v3/telemetry/host/hardwareCapacity/current HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "cpuPercentage": 1,
    "ramPercentage": 1,
    "diskPercentage": 1
  }
]

List the historical data of status of all your Hosts

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Query parameters

startTimeintegerOptional

Unix timestamp. Filter from time, default value is -1 day

endTimeintegerOptional

Unix timestamp. Filter to time, default value is now

Responses

200

OK

application/json

unitstringRead-onlyRequired

Unit of data frequency

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/host/onlineStatus

HTTPcURLJavaScriptPython

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

[
  {
    "unit": "text",
    "host": [
      {
        "timestamp": 1,
        "data": [
          {
            "hostType": 1,
            "online": 1,
            "install": 1,
            "offline": 1,
            "unknown": 1
          }
        ]
      }
    ]
  }
]

List the statuses of currently available Hosts

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

timestampinteger · integerRead-onlyRequired

The unix time stamp

hostTypeinteger · integerRead-onlyRequired

Type of the host e.g

• 1: Bare metal
• 2: Flex metal
• 3: Cloud

onlineinteger · integerRead-onlyRequired

The number of hosts with status online

onlinePercentageinteger · integerRead-onlyRequired

The percentage of hosts with status online

installinteger · integerRead-onlyRequired

The number of hosts with status installing

installPercentageinteger · integerRead-onlyRequired

The percentage of hosts with status installing

offlineinteger · integerRead-onlyRequired

The number of hosts with status offline

offlinePercentageinteger · integerRead-onlyRequired

The percentage of hosts with status offline

unknowninteger · integerRead-onlyRequired

The number of hosts with status unknown

unknownPercentageinteger · integerRead-onlyRequired

The percentage of hosts with status unknown

totalinteger · integerRead-onlyRequired

The total number of hosts

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/host/onlineStatus/current

HTTPcURLJavaScriptPython

GET /v3/telemetry/host/onlineStatus/current HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "timestamp": 1,
    "hostType": 1,
    "online": 1,
    "onlinePercentage": 1,
    "install": 1,
    "installPercentage": 1,
    "offline": 1,
    "offlinePercentage": 1,
    "unknown": 1,
    "unknownPercentage": 1,
    "total": 1
  }
]

List of hosts that have traffic overuse

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringRequired

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

Responses

200

OK

application/json

hostIdinteger · integerRead-onlyRequired

The ID of the host

hostNamestringRead-onlyRequired

The name of the physical machine

orderedBandwidthnumber · floatRead-onlyRequired

Allowed bandwidth of the host

usedBandwidthnumber · floatRead-onlyRequired

Used bandwidth of the host

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/host/overuse/current

HTTPcURLJavaScriptPython

GET /v3/telemetry/host/overuse/current HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
RANGED-DATA: text
Accept: */*

[
  {
    "hostId": 1,
    "hostName": "text",
    "orderedBandwidth": 1,
    "usedBandwidth": 1
  }
]