Resource Status Tracking (HTTP API)

73KB

Resources Status Schema.yaml

get

Query parameters

serviceIdsstring[] · max: 100optional

Limit to ServiceIDs

resourceIdsstring[] · max: 100optional

Limit to ResourceIDs

pageinteger · min: 1optional

A page number

Default: 1

itemsPerPageinteger · min: 1 · max: 100optional

Number of items per page

Default: 50

Responses

application/jsontext/event-stream

objectoptional

get

HTTPcURLJavaScriptPython

GET /api/v2/resources/states/deviations HTTP/1.1
Host: 
Accept: */*

200

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": 1
    }
  }
}

get

Query parameters

idsstring[] · max: 100optional

Limit to ServiceIDs

pageinteger · min: 1optional

A page number

Default: 1

itemsPerPageinteger · min: 1 · max: 100optional

Number of items per page

Default: 50

Responses

application/jsontext/event-stream

objectoptional

get

HTTPcURLJavaScriptPython

GET /api/v2/resources/states/deviations/count HTTP/1.1
Host: 
Accept: */*

200

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": 1
    }
  }
}

get

Query parameters

serviceIdsstring[] · max: 100optional

Limit to ServiceIDs

resourceIdsstring[] · max: 100optional

Limit to ResourceIDs

deviatedall ofoptional

Return only deviated resources

Flag indicating if a deviation was detected or not

pageinteger · min: 1optional

A page number

Default: 1

itemsPerPageinteger · min: 1 · max: 100optional

Number of items per page

Default: 50

Responses

application/jsontext/event-stream

objectoptional

get

HTTPcURLJavaScriptPython

GET /api/v2/resources/states HTTP/1.1
Host: 
Accept: */*

200

List of resources including their state and status. If no ServiceIDs and no ResourceIDs are provided, it acts as a wildcard request. Filtering for ResourceIds takes precedence over filtering for ServiceIds. Meaning as soon as ResourceIDs are provided, the ServiceIDs 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": 1
    }
  }
}

get

Query parameters

namesstring[] · max: 100optional

Limit to specific runners

pageinteger · min: 1optional

A page number

Default: 1

itemsPerPageinteger · min: 1 · max: 100optional

Number of items per page

Default: 50

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

GET /api/v2/resource-runners HTTP/1.1
Host: 
Accept: */*

200

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": 1
    }
  }
}

get

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

GET /api/v2/resources/rst/httpschemas HTTP/1.1
Host: 
Accept: */*

200

Every RST related http endpoint definition

{
  "data": {
    "[a-zA-Z0-9]+": {},
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}