Get integration | Cloud Providers | Northflank API docs
v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Cloud Providers /

Get integration

Get information about the given integration

Required permission

Account > Cloud > Integrations > Read

Path parameters

    • integrationId

      string required

      ID of the provider integration

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • id

        string required

        Identifier for the integration.

      • name

        string required

        The name of the integration.

      • description

        string

        A short description of the integration.

      • credentials

        {object} required

        Cloud provider credential input, required fields dependent on which provider is chosen.

        • keyfileJson

          string

          Contents of a GCP key file.

        • accessKey

          string

          AWS access key.

        • secretKey

          string

          AWS secret key.

        • apiKey

          string

          DO API key.

      • createdAt

        string required

        The time the integration was created.

API
CLI
JS Client

GET /v1/cloud-providers/integrations/{integrationId}

Example response

200 OK

Details about the given integration.

JSON

{
  "data": {
    "id": "gcp-integration",
    "name": "GCP integration",
    "description": "The integration description",
    "createdAt": "2021-01-20T11:19:53.175Z"
  }
}

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com