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

Cloud Providers /

Create integration

Creates a new integration.

Required permission

Account > Cloud > Integrations > Create

Request body

  • {object}

    • name

      string required

      The name of the cloud provider integration.

      min length
      3
      max length
      39
      pattern
      ^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$

    • description

      string

      The description of the integration.

      max length
      200
      pattern
      ^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$

    • provider

      string required

      Cloud provider to be used for the selected resource

      one of
      aws, azure, civo, gcp, byok

    • type

      string

      The type of provider integration.

      one of
      cluster, domain, registry, cdn

    • 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.

    • gcp

      {object}

      GCP specific data. Required when provider is gcp.

      • projectId

        string required

        Project ID

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

POST /v1/cloud-providers/integrations

Example request

Request body
curl
curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"name":"New Integration","description":"This is a new cloud provider integration.","provider":"gcp","type":"cluster"}' \
  https://api.northflank.com/v1/cloud-providers/integrations

Example response

200 OK

Details about the created 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