v1
Double column
API
CLI
JS Client

Integrations /

List registry credentials

Lists the container registry credentials saved to this account. Does not display secrets.

Required permission

Account > Credentials > General > 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.

      • credentials

        [array] required

        An array of credentials saved to this account.

        • {object}
          • id

            string required

            Identifier for the credentials.

          • name

            string required

            Name of the saved credentials.

          • description

            string required

            Description of the saved credentials.

          • restrictions

            {object} required

            Data about whether the credentials are restricted to certain projects.

            • restricted

              boolean required

              Whether the credentials are restricted to specific projects.

            • projects

              [array] required

              An array of projects the credentials are restricted to, if applicable.

              • string

                The internal id of the project.

          • provider

            string required

            The registry provider associated with this set of credentials.

            one of
            dockerhub, gcr-eu, gcr-us, gitlab, github, custom
    • 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/registry-credentials

Example response

200 OK

A list of registry credentials saved to this account.

JSON

{
  "data": {
    "credentials": [
      {
        "id": "example-credentials",
        "name": "Example Credentials",
        "description": "This is a set of saved credentials.",
        "restrictions": {
          "restricted": true,
          "projects": [
            "default-project"
          ]
        },
        "provider": "dockerhub"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}

© 2022 Northflank Ltd. All rights reserved.