Skip to main content
POST
Get instance metrics

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id
integer
required

Project ID

region_id
integer
required

Region ID

instance_id
string<uuid4>
required

Instance ID

Query Parameters

limit
integer
default:1000

Optional. Limit the number of returned items

Required range: x <= 1000
Example:

1000

offset
integer
default:0

Optional. Offset value is used to exclude the first set of records from the result

Required range: x >= 0
Example:

0

Body

application/json

Time range and time unit, required to obtain instance metrics. Available intervals are 1h, 6h, 24h, 7 days, 14 days. Time delta in the results is fixed and depends on the time range: 1h - 15 seconds, 6h - 20 seconds, 24h - 2 minutes, 7 days - 10 minutes, 14 days - 20 minutes.

time_interval
integer
required

Time interval.

Example:

6

time_unit
enum<string>
required

Time interval unit.

Available options:
day,
hour
Example:

"hour"

Response

200 - application/json

OK

count
integer
required

Number of objects

Required range: x >= 0
Example:

1

results
InstanceMetricsSerializer · object[]
required

Objects