Resource Status Tracking (HTTP API)
Limit to ServiceID
s
Limit to ResourceID
s
A page number
1
Number of items per page
50
GET /api/v2/resources/states/deviations HTTP/1.1
Host:
Accept: */*
List of resource state deviations, allowing to identify resources that have diverged from their expected states
{
"data": [
{
"resource": {
"id": "myService-myResource",
"name": "myResource"
},
"state": {
"desired": "connected",
"current": "connected"
},
"runnerInfo": {
"name": "protocol-mapper",
"status": "healthy"
},
"deviated": true,
"info": "Host not reachable"
}
],
"meta": {
"pagination": {
"totalPages": 1,
"totalRows": 1,
"pageNumber": 1,
"totalRowsInPage": 1,
"nextPage": 1,
"rowsPerPage": 50
}
}
}
Limit to ServiceID
s
A page number
1
Number of items per page
50
GET /api/v2/resources/states/deviations/count HTTP/1.1
Host:
Accept: */*
Number of resources currently in a deviated state. If no filter is applied the number represents the system wide deviations.
{
"data": [
{
"serviceId": "myService",
"count": 42
}
],
"meta": {
"pagination": {
"totalPages": 1,
"totalRows": 1,
"pageNumber": 1,
"totalRowsInPage": 1,
"nextPage": 1,
"rowsPerPage": 50
}
}
}
Limit to ServiceID
s
Limit to ResourceID
s
Return only deviated resources
Flag indicating if a deviation was detected or not
false
A page number
1
Number of items per page
50
GET /api/v2/resources/states HTTP/1.1
Host:
Accept: */*
List of resources including their state and status.
If no ServiceID
s and no ResourceID
s are provided, it acts as a wildcard request.
Filtering for ResourceIds takes precedence over filtering for ServiceIds. Meaning as soon as ResourceID
s are provided, the ServiceID
s will be ignored.
{
"data": [
{
"resource": {
"id": "myService-myResource",
"name": "myResource"
},
"state": {
"desired": "connected",
"current": "connected"
},
"runnerInfo": {
"name": "protocol-mapper",
"status": "healthy"
},
"deviated": true,
"info": "Host not reachable"
}
],
"meta": {
"pagination": {
"totalPages": 1,
"totalRows": 1,
"pageNumber": 1,
"totalRowsInPage": 1,
"nextPage": 1,
"rowsPerPage": 50
}
}
}
Limit to specific runner
s
A page number
1
Number of items per page
50
GET /api/v2/resource-runners HTTP/1.1
Host:
Accept: */*
List of heartbeats
{
"data": [
{
"name": "protocol-mapper",
"healthy": true,
"last": 1716543812,
"misses": 1,
"remainingMissedHeartbeats": 1
}
],
"meta": {
"pagination": {
"totalPages": 1,
"totalRows": 1,
"pageNumber": 1,
"totalRowsInPage": 1,
"nextPage": 1,
"rowsPerPage": 50
}
}
}
GET /api/v2/resources/rst/httpschemas HTTP/1.1
Host:
Accept: */*
Every RST related http endpoint definition
{
"data": {
"[a-zA-Z0-9]+": {},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
Last updated
Was this helpful?