Sign in
Context Interfaces

List all Context Interfaces

Returns an array of Context Interfaces.

get/v1/context-interfaces

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

Filter for Context Interfaces.

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 Context Interfaces. Supported sort attributes are:

  • name
  • created_at
  • updated_at

Default sort is name in ascending order.

Response

A response to listing Context Interfaces.

Example response

{
  "data": [
    {
      "labels": {
        "env": "test"
      },
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z"
    }
  ],
  "meta": {
    "page": {
      "size": 10
    }
  }
}

Changes

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