Sign in
Catalog Services

List Services

Returns a paginated collection of services.

get/v1/catalog-services

Query parameters

page[size]integer
Example:10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]integer
Example:1

Determines which page of the entities to retrieve.

Filters a collection of services.

{
  "custom_fields": 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 services. Supported sort attributes are:

  • display_name
  • name
  • created_at
  • updated_at

Default sort is display_name in ascending order.

Response

A paginated list response for a collection of services.

Example response

{
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  },
  "data": [
    {
      "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
      "name": "user-svc",
      "display_name": "User Service",
      "custom_fields": {
        "owner": "John Appleseed",
        "dashboard": {
          "name": "On-Call Dashboard",
          "link": "https://my-dashboard-svc.io/dashboards/1"
        }
      },
      "labels": {
        "env": "test"
      },
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z"
    }
  ]
}

Changes

Changed in 1 of the 75 revisions of this API.1