v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Cloud Providers /

Get docker registry

Get information about the given docker registry

Required permission

Account > Cloud > Registries > Read

Path parameters

    • registryId

      string required
      ID of the docker registry

Response body

  • {object}
    Response object.

    • data

      {object} required
      Result data.

      • id

        string required
        ID of the registry
        min length
        3
        max length
        39
        pattern
        ^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

      • name

        string required
        The name of the cloud provider registry.
        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\\/'"()[\];`%^&*\-_:!]+$

      • uid

        string
        Unique id of the registry.

      • provider

        string required
        Cloud provider to be used for the selected resource
        one of
        aws, azure, civo, gcp, oci, cloudflare, byok

      • region

        string required

      • integrationId

        string
        Integration to use for this registry.
        pattern
        ^((org|team)\/)?[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

      • restrictions

        {object}
        BYOC restrictions configuration for controlling team access

        • enabled

          boolean required
          Enable or disable BYOC restrictions for this entity

        • teams

          [array]
          List of teams that have access to this BYOC cluster
          • {object}

            • teamId

              string required
              The ID of the team that has access to this BYOC cluster

      • updatedAt

        string
        time of update

      • createdAt

        string
        time of creation
API
CLI
JS Client

GET /v1/cloud-providers/docker-registries/{registryId}

Example response

200 OK

Details about the given docker registry.

JSON

{
  "data": {
    "id": "example-registry",
    "name": "Example Registry",
    "description": "This is a new cloud provider registry.",
    "uid": "nf-n7xyvdn4",
    "provider": "gcp",
    "region": "eu-west-1",
    "integrationId": "gcp-integration"
  }
}

© 2025 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com