Sign in
Integration Instances

List Integration Instances

Returns a paginated collection of integration instances.

get/v1/integration-instances

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.

authorizedboolean

Filter by a boolean value (true/false).

Filters a collection of integration instances.

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

  • display_name
  • name
  • created_at
  • updated_at
  • integration.display_name

Default sort is integration.display_name in ascending order.

Response

A paginated list response for a collection of integration instances.

Example response

{
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  },
  "data": [
    {
      "id": "3f51fa25-310a-421d-bd1a-007f859021a3",
      "name": "aws-lambda-prod",
      "display_name": "AWS (prod)",
      "integration": {
        "name": "gateway-manager",
        "display_name": "gateway-manager"
      },
      "authorized": true,
      "labels": {
        "env": "test"
      },
      "config": {
        "account_region": "eu"
      },
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z"
    }
  ]
}

Changes

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