v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Cloud Providers /

List docker registries

Lists docker registries for the authenticated user or team.

Required permission

Account > Cloud > Registries > 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.

      • 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, byok

      • region

        string required

      • 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

    • 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/docker-registries

Example response

200 OK

A list of docker registries for the authenticated user

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"
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}

© 2025 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com