List integrations | Cloud Providers | Northflank API docs
v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Cloud Providers /

List integrations

Lists integrations for the authenticated user or team.

Required permission

Account > Cloud > Integrations > Read

Query parameters

    • per_page

      integer

      The number of results to display per request. Maximum of 100 results per page.

    • page

      integer

      The page number to access.

    • cursor

      string

      The cursor returned from the previous page of results, used to request the next page.

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • integrations

        [array] required

        An array of integrations.

        • {object}

          An integration object.

          • id

            string required

            Identifier for the integration.

          • name

            string required

            The name of the integration.

          • description

            string

            A short description of the integration.

          • provider

            string

            The cloud provider to which this integration belongs to.

          • createdAt

            string required

            The time the integration was created.

    • pagination

      {object} required

      Data about the endpoint pagination.

      • hasNextPage

        boolean required

        Is there another page of results available?

      • cursor

        string

        The cursor to access the next page of results.

      • count

        number required

        The number of results returned by this request.

API
CLI
JS Client

GET /v1/cloud-providers/integrations

Example response

200 OK

A list of integrations for the authenticated user

JSON

{
  "data": {
    "integrations": [
      {
        "id": "gcp-integration",
        "name": "GCP integration",
        "description": "The integration description",
        "provider": "gcp",
        "createdAt": "2021-01-20T11:19:53.175Z"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com