Sign in

v61

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB
Catalog Resources

List Resources

Returns a paginated collection of resources.

get/v1/resources

Query parameters

sizeinteger

The number of items included per page.

afterstring

Cursor param specifying the page (i.e. the next page) of data returned.

beforestring

Cursor param specifying the page (i.e. the previous page) of data returned.

Determines which page of the collection to retrieve.

{
  "size": 10,
  "after": "ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ",
  "before": "ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ"
}
archivedboolean

Filter by a boolean value (true/false).

Filters a collection of resources.

{
  "service_associations": 21,
  "created_at": {
    "eq": "2022-03-30T07:20:50Z"
  },
  "updated_at": {
    "eq": "2022-03-30T07:20:50Z"
  }
}
sortstring

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').

Example:created_at desc

Sorts a collection of resources. Supported sort attributes are:

  • created_at
  • updated_at

Default sort is created_at in descending order.

Response

A paginated list response for a collection of resources.

Example response

{
  "meta": {
    "page": {
      "size": 10
    }
  },
  "data": [
    {
      "id": "4UdXnoaDYYJsH_Ir",
      "integration": {
        "name": "gateway-manager",
        "display_name": "gateway-manager",
        "instance": {
          "id": "772b9caf-ddbc-4f4f-8aa4-8dfbbe420351",
          "name": "aws-lambda-prod",
          "display_name": "AWS (prod)"
        }
      },
      "type": "gateway_svc",
      "config": {
        "control_plane_id": "ccadfb0a-56cd-4f74-955d-aec1d87157c8",
        "gateway_service_id": "94896d05-0c4d-45eb-aae3-de754885dd58"
      },
      "service_associations": 2,
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z"
    }
  ]
}