v1
Double column
API
CLI
JS Client

Integrations /

Add registry

Adds a new set of container registry credentials to this account.

Required permission

Account > Credentials > General > Create

Request body

  • {object}
    • name

      string required
      The name of the docker credentials.
      min length
      3
      max length
      39
      pattern
      ^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$
    • provider

      string required
      The provider of the docker registry.
      one of
      acr, ecr, gar, dockerhub, github, gitlab, custom, legacy
    • registryUrl

      string
      The URL of the docker registry.
    • aws

      {object}
      • region

        string
        The region of the docker registry.
    • gcp

      {object}
      • projectId

        string
        The project ID of the GCP docker registry.
    • azure

      {object}
      • resourceGroup

        string
        The resource group of the Azure docker registry.
    • integrationId

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

      {object}
      • username

        string
        Username for the docker registry. Required when `integrationId` is provided.
      • password

        string
        Password for the docker registry. Required when `integrationId` is provided.
      • scope

        {object} required
        • pull

          boolean
          Whether the credentials can pull images.
        • push

          boolean
          Whether the credentials can push images.
    • restrictions

      {object}
      • restricted

        boolean required
        Whether access to this credential is restricted.
      • projects

        [array]
        List of projects that have access to this credential.
        • string
    • updatedAt

      string
      time of update
    • createdAt

      string
      time of creation

Response body

  • {object}
    Response object.
    • data

      {object} required
      Result data.
      • id

        string required
        ID of the docker credentials
        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 docker credentials.
        min length
        3
        max length
        39
        pattern
        ^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$
      • provider

        string required
        The provider of the docker registry.
        one of
        acr, ecr, gar, dockerhub, github, gitlab, custom, legacy
      • registryUrl

        string
        The URL of the docker registry.
      • aws

        {object}
        • region

          string
          The region of the docker registry.
      • gcp

        {object}
        • projectId

          string
          The project ID of the GCP docker registry.
      • azure

        {object}
        • resourceGroup

          string
          The resource group of the Azure docker registry.
      • integrationId

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

        {object}
        • username

          string
          Username for the docker registry. Required when `integrationId` is provided.
        • password

          string
          Password for the docker registry. Required when `integrationId` is provided.
        • scope

          {object} required
          • pull

            boolean
            Whether the credentials can pull images.
          • push

            boolean
            Whether the credentials can push images.
      • restrictions

        {object}
        • restricted

          boolean required
          Whether access to this credential is restricted.
        • projects

          [array]
          List of projects that have access to this credential.
          • string
      • updatedAt

        string
        time of update
      • createdAt

        string
        time of creation
API
CLI
JS Client

POST /v1/integrations/registries

Example request

Request body
curl
curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"name":"Example Docker Credentials"}' \
  https://api.northflank.com/v1/integrations/registries

Example response

200 OK

Data about the newly created credentials.

JSON

{
  "data": {
    "id": "example-credentials",
    "name": "Example Docker Credentials"
  }
}

© 2025 Northflank Ltd. All rights reserved.