HostTelemetry

Host telemetry requests

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

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
hostIdintegerRequired
Query parameters
startTimeintegerOptional

Start unix timestamp

endTimeintegerOptional

End unix timestamp

Responses
chevron-right
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)

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

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

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
hostIdintegerRequired
Query parameters
startTimeintegerOptional

Start unix timestamp

endTimeintegerOptional

End unix timestamp

Responses
chevron-right
200

OK

application/json
unitstringRead-onlyRequired

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

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

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

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
hostIdintegerRequired
Query parameters
startTimeintegerOptional

Start unix timestamp

endTimeintegerOptional

End unix timestamp

Responses
chevron-right
200

OK

application/json
unitstringRead-onlyRequired

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

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

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

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
hostIdintegerRequired
Query parameters
startTimeintegerOptional

Start unix timestamp

endTimeintegerOptional

End unix timestamp

Responses
chevron-right
200

OK

application/json
unitstringRead-onlyRequired

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

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

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

get
Authorizations
PRIVATE-TOKENstringRequired
Query parameters
filterstringOptional

You can filter based on following parameters

  • deploymentEnvironmentId
  • fleetId
  • deploymentRegionId
  • dcLocationId
Responses
chevron-right
200

OK

application/json
unitstringRead-onlyRequired

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

get
/v3/telemetry/host/utilization

Get the average of server host status telemetry

get
Authorizations
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
chevron-right
200

OK

application/json
unitstringRead-onlyRequired

Unit of data frequency, possible interval options are as follows

  • minute
  • hour
  • day
  • month
get
/v3/telemetry/host/utilization/aggregate

List the historical data of hardware capacity of all your Hosts

get
Authorizations
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
chevron-right
200

OK

application/json
unitstringRead-onlyRequired

Unit of data frequency

get
/v3/telemetry/host/hardwareCapacity

List the current hardware capacity of all your Hosts

get
Authorizations
PRIVATE-TOKENstringRequired
Query parameters
filterstringOptional

You can filter based on following parameters

  • deploymentEnvironmentId
  • fleetId
Responses
chevron-right
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

get
/v3/telemetry/host/hardwareCapacity/current

List the historical data of status of all your Hosts

get
Authorizations
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
chevron-right
200

OK

application/json
unitstringRead-onlyRequired

Unit of data frequency

get
/v3/telemetry/host/onlineStatus

List the statuses of currently available Hosts

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
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

get
/v3/telemetry/host/onlineStatus/current

List of hosts that have traffic overuse

get
Authorizations
PRIVATE-TOKENstringRequired
Header parameters
RANGED-DATAstringRequired

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

Responses
chevron-right
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

get
/v3/telemetry/host/overuse/current

Last updated

Was this helpful?