ColocationTelemetry

ColocationTelemetry service endpoints

Gets the network telemetry for a given colocation on hourly basis (default = last 24 hours)

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

Query parameters

startTimeintegerOptional

Start unix timestamp

endTimeintegerOptional

End unix timestamp

Responses

200

OK

application/json

unitstringRead-onlyRequired

Unit of data frequency (hour by default)

404

Error Colocation not found

500

Internal Server Error

application/json

get

/v3/telemetry/colocation/{colocationId}/network

HTTPcURLJavaScriptPython

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

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

Get the history list of power usage for all colocation

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, which is always null in this endpoint. This property is there for consistency across all telemetry endpoints. It's null because the data is not aggregated

400

Bad Request

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/colocation/powerUsage

HTTPcURLJavaScriptPython

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

[
  {
    "unit": "text",
    "data": [
      {
        "timestamp": 1,
        "amps": 1,
        "volts": 1,
        "kwh": 1,
        "powerMeter": 1
      }
    ]
  }
]

Get the list of all colocation current power usage

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

idinteger · integerRead-onlyRequired

The ID of the colocation service

namestringRead-onlyRequired

The name of the colocation service

kwhinteger · integerRead-onlyRequired

Current month kilo watts per hour

400

Bad Request

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/colocation/powerUsage/current

HTTPcURLJavaScriptPython

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

[
  {
    "id": 1,
    "name": "text",
    "kwh": 1
  }
]

Deprecated

Get the history list of power usage for a colocation and pdu

get

Use GET /v3/telemetry/pdu/{pduId} instead

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

pduIdintegerRequired

Query parameters

startTimeintegerOptional

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

endTimeintegerOptional

Unix timestamp. Filter to time, default value is now

Header parameters

RANGED-DATAstringRequired

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

Responses

200

OK

application/json

timestampinteger · integerRead-onlyRequired

The time at which the last update occurred

ampsnumber · floatRead-onlyRequired

The value of amps at that time

voltsnumber · floatRead-onlyRequired

The value of volts at that time

kwhnumber · floatRead-onlyRequired

The value of kwh at that time

powerMeterinteger · integerRead-onlyRequired

The value of power meter at that time

400

Bad Request

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/telemetry/colocation/{colocationId}/pdu/{pduId}

HTTPcURLJavaScriptPython

GET /v3/telemetry/colocation/{colocationId}/pdu/{pduId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
RANGED-DATA: text
Accept: */*

[
  {
    "timestamp": 1,
    "amps": 1,
    "volts": 1,
    "kwh": 1,
    "powerMeter": 1
  }
]

List of overuse host

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

coloIdinteger · integerRead-onlyRequired

The ID of the colocation

coloNamestringRead-onlyRequired

The name of the colocation

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/colocation/overuse/current

HTTPcURLJavaScriptPython

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

[
  {
    "coloId": 1,
    "coloName": "text",
    "orderedBandwidth": 1,
    "usedBandwidth": 1
  }
]