Skip to navigation

Rotate registry access token

Issues a new secret for an active token; the old secret stops working immediately. The new secret is returned once. Revoked or expired tokens return 409. Requires scope: container-registry.write.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# REGISTRY_ID: Registry ID
# TOKEN_ID: Registry access token ID
curl -X POST "https://api.ibee.ai/v1/container-registry/registries/$REGISTRY_ID/access-tokens/$TOKEN_ID/rotate?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

registry_idstringRequiredformat: "uuid"
Registry ID.
token_idstringRequiredformat: "uuid"
Registry access token ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Response

Secret rotated. Store the new secret now.
token_idstringformat: "uuid"
Unique ID of the token.
token_namestring
Name of the token.
usernamestring

Docker login username. It contains $, so quote it in shells.

secretstring
Docker login password. Returned only by create and rotate.
permissionenum

What a registry access token may do.

  • PULL: pull images.
  • PULL_PUSH: pull and push images.
Allowed values:
registry_idslist of strings
Registries the token may use.
expires_atdatetime or null

When the token expires (ISO 8601); null for a token that does not expire.

created_atdatetime

When the token was created (ISO 8601).

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error