Get registry | Integrations | Northflank API docs
v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Integrations /

Get registry

Views a set of registry credential data.

Required permission

Account > Credentials > General > Read Encrypted

Path parameters

    • credentialId

      string required

      ID of the registry credential

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • 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 id of the project.

      • provider

        string required

        The registry provider associated with this set of credentials.

        one of
        dockerhub, gcr, gcr-eu, gcr-us, gitlab, github, custom

      • auths

        {object}

        The auths data extracted from your Docker config file.

    API
    CLI
    JS Client

    GET /v1/integrations/registries/{credentialId}

    Example response

    200 OK

    Data about the registry credentials.

    JSON

    {
  "data": {
    "id": "example-credentials",
    "name": "Example Credentials",
    "description": "This is a set of saved credentials.",
    "restrictions": {
      "restricted": true,
      "projects": [
        "default-project"
      ]
    },
    "provider": "dockerhub",
    "auths": {
      "https://index.docker.io/v1/": {
        "auth": "[YOUR AUTH KEY]"
      }
    }
  }
}

    © 2024 Northflank Ltd. All rights reserved.

    northflank.comTermsPrivacyfeedback@northflank.com