v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Cloud Providers /

Create docker registry

Creates a new docker registry.

Required permission

Account > Cloud > Registries > 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, oci, byok

    • region

      string required

    • integrationId

      string
      Existing integration to use for this registry.
      min length
      3
      max length
      39
      pattern
      ^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

    • type

      string
      The type of provider integration.
      one of
      byoc, byoc-static-egress, byoc-custom-vpc, cloudfront, self-hosted-registry, route53, self-hosted-logs-metrics, docker-registry-credential

Response body

  • {object}
    Response object.

    • data

      {object} required
      Result data.

      • id

        string required
        Identifier for the docker registry.

      • name

        string required
        The name of the docker registry.

      • description

        string
        A short description of the docker registry.

      • provider

        string
        The cloud provider to which this docker registry belongs to.

      • region

        string
        The region in which this registry was created.

      • createdAt

        string required
        The time the registry was created.
API
CLI
JS Client

POST /v1/cloud-providers/docker-registries

Example request

Request body
curl
curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"name":"Example Integration","description":"This is a new cloud provider integration.","region":"eu-west-1","integrationId":"gcp-integration","type":"byoc"}' \
  https://api.northflank.com/v1/cloud-providers/docker-registries

Example response

200 OK

Details about the created docker registry.

JSON

{
  "data": {
    "id": "gcp-integration",
    "name": "GCP integration",
    "description": "The registry description",
    "provider": "aws",
    "region": "eu-west-1",
    "createdAt": "2021-01-20T11:19:53.175Z"
  }
}

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com