Sign in
Registries

Update registry

Updates an existing registry. All fields are optional; only provided fields are changed. Admin role required. Updating a Docker Hub, GHCR, or custom registry is available on every tier. Updating an AWS ECR registry requires an Admiral license. API tokens receive SCOPE_DENIED.

put/api/registries/{id}

Path parameters

idinteger required

Numeric resource ID.

Request body

namestring required
urlstring required
type'dockerhub' | 'ghcr' | 'ecr' | 'custom' required
usernamestring required
secretstring required

Password, token, or access key. Write-only — never returned in GET responses.

aws_regionstring

Required when type is ecr.

Example request

{
  "name": "GitHub Container Registry",
  "url": "ghcr.io",
  "username": "my-user",
  "aws_region": "us-east-1"
}

Response

Registry updated.

successboolean required

Example response

{
  "success": true
}

Changes

Changed in 5 of the 36 revisions of this API.1410

  • d58cf9d6195b4See the full diff
    • ○

      removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 400

      response-property-enum-value-removed

    • ○

      removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 403

      response-property-enum-value-removed

    • ○

      removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 404

      response-property-enum-value-removed

    • ○

      removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 500

      response-property-enum-value-removed

  • 7464894ea58244See the full diff
    • ●

      added the new PAID_REQUIRED enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new PAID_REQUIRED enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new PAID_REQUIRED enum value to the code response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new PAID_REQUIRED enum value to the code response property for the response status 500

      response-property-enum-value-added

    • ○

      removed the PRO_REQUIRED enum value from the code response property for the response status 400

      response-property-enum-value-removed

    • ○

      removed the PRO_REQUIRED enum value from the code response property for the response status 403

      response-property-enum-value-removed

    • ○

      removed the PRO_REQUIRED enum value from the code response property for the response status 404

      response-property-enum-value-removed

    • ○

      removed the PRO_REQUIRED enum value from the code response property for the response status 500

      response-property-enum-value-removed

  • a202861afa641See the full diff
    • ○

      endpoint added

      endpoint-added

  • 82927cbcc9f71See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

  • b98c5381766d1See the full diff
    • ○

      endpoint added

      endpoint-added