Resource Status Tracking (API)

63KB

Resources Status Schema.yaml

Open

get

Authorizations

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

200

List of resource state deviations, allowing to identify resources that have diverged from their expected states

503

Service Unavailable (Infrastructure error)

text/plain

get

/api/v2/resources/states/deviations

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

{
  "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
    }
  }
}

get

Authorizations

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

200

Number of resources currently in a deviated state. If no filter is applied the number represents the system wide deviations.

503

Service Unavailable (Infrastructure error)

text/plain

get

/api/v2/resources/states/deviations/count

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

{
  "data": [
    {
      "serviceId": "myService",
      "count": 42
    }
  ],
  "meta": {
    "pagination": {
      "totalPages": 1,
      "totalRows": 1,
      "pageNumber": 1,
      "totalRowsInPage": 1,
      "nextPage": 1,
      "rowsPerPage": 50
    }
  }
}

get

Authorizations

Query parameters

orderBystring · enumOptional

Order response by field

Default: serviceIdPossible values:

orderstring · enumOptional

Ascending or descending order

Default: ASCPossible values:

pageinteger · min: 1Optional

A page number

Default: 1

itemsPerPageinteger · min: 1 · max: 100Optional

Number of items per page

Default: 50

searchTextstringOptional

The value used to retrieve services by matching service IDs

Responses

200

Returns a list of deviated ServiceIds along with their number of deviated resources

400

Bad Request

application/json

500

Internal Server Error

application/json

503

Service Unavailable (Infrastructure error)

text/plain

get

/api/v2/resources/states/deviations/services

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

{
  "jsonapi": {
    "version": "1.1.1"
  },
  "data": [
    {
      "serviceId": "myService",
      "count": 42
    }
  ],
  "meta": {
    "pagination": {
      "totalPages": 1,
      "totalRows": 1,
      "pageNumber": 1,
      "totalRowsInPage": 1,
      "nextPage": 1,
      "rowsPerPage": 50
    }
  }
}

get

Authorizations

Query parameters

serviceIdsstring[] · max: 100Optional

Limit to ServiceIDs

resourceIdsstring[] · max: 100Optional

Limit to ResourceIDs

deviatedall ofOptional

Return only deviated resources

booleanOptional

Flag indicating if a deviation was detected or not

and

anyOptionalDefault: false

pageinteger · min: 1Optional

A page number

Default: 1

itemsPerPageinteger · min: 1 · max: 100Optional

Number of items per page

Default: 50

Responses

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.

503

Service Unavailable (Infrastructure error)

text/plain

get

/api/v2/resources/states

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

{
  "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
    }
  }
}

get

Authorizations

Query parameters

namesstring[] · max: 100Optional

Limit to specific runners

pageinteger · min: 1Optional

A page number

Default: 1

itemsPerPageinteger · min: 1 · max: 500Optional

Number of items per page

Default: 50

Responses

200

List of heartbeats

application/json

503

Service Unavailable (Infrastructure error)

text/plain

get

/api/v2/resource-runners

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

{
  "data": [
    {
      "name": "protocol-mapper",
      "healthy": true,
      "last": 1716543812,
      "misses": 1,
      "remainingMissedHeartbeats": 1,
      "hostname": "text",
      "version": "text"
    }
  ],
  "meta": {
    "pagination": {
      "totalPages": 1,
      "totalRows": 1,
      "pageNumber": 1,
      "totalRowsInPage": 1,
      "nextPage": 1,
      "rowsPerPage": 50
    }
  }
}

get

Authorizations

Responses

200

Every RST related http endpoint definition

application/json

503

Service Unavailable (Infrastructure error)

text/plain

get

/api/v2/resources/rst/httpschemas

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

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

PreviousSystem Status (API)NextTopic Explorer (API)

Last updated 2 months ago

Was this helpful?