v1
Double column
API
CLI
JS Client

Integrations /

Update registry credentials

Updates a set of registry credential data.

Required permission

Account > Credentials > General > Update

Path parameters

    • credentialId

      string required

      ID of the registry credential

Request body

  • {object}
    • description

      string

      Description of the credentials.

      max length
      200
      pattern
      ^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
    • restrictions

      {object}

      Data about whether the credentials are restricted to certain projects.

      • restricted

        boolean required

        Whether the credentials are restricted to specific projects.

      • projects

        [array]

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

        • string

          The internal id of the project.

          pattern
          ^[A-Za-z0-9-]+$
    • data

      {object}

      The registry credential data to save.

    Response body

    • {object}

      Response object.

      • data

        {object} required

        Result data.

      API
      CLI
      JS Client

      POST /v1/registry-credentials/{credentialId}/modify

      Example request

      Request body

      curl
      curl --header "Content-Type: application/json" \
        --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
        --request POST \
        --data '{"description":"This is a set of saved credentials.","restrictions":{"restricted":true,"projects":["default-project"]},"data":{"auths":{"https://index.docker.io/v1/":{"auth":"[YOUR AUTH KEY]"}}}}' \
        https://api.northflank.com/v1/registry-credentials/{credentialId}/modify

      Example response

      200 OK

      The operation was performed successfully.

      JSON

      {
        "data": {}
      }

      © 2022 Northflank Ltd. All rights reserved.