Skip to content
Hayonix

API reference · Registry credentials

Update registry credentials

PATCH/v1/registry-credentials/{registry_credential_id}
API keyregistry_credential:updateProject
TypeScript
client.registryCredentials.update()
Python
client.registry_credentials.update()
CLI
hayonix registry-credentials update

Changes only the fields sent, for example to rotate the password. Containers already created are not affected; the new details are used the next time a container is created.

Project API key (Authorization: Bearer sk_…), or a console session. Requires the registry_credential:update permission (a key's scope, or a role that includes it).

Examples

The samples read API_KEY and API_BASE_URL from the environment (see Setup). Values are examples.

curl -sS -X PATCH "$API_BASE_URL/registry-credentials/rcr_01jc5zq4m8k3v6x9t2w7r0b1e4" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "password": "ghp_rotated"
}'

Request

Headers
HeaderRequiredDescription
AuthorizationyesBearer and your API key. The key implies its project.
X-Project-Idsession onlyThe project to act in, for console sessions. Requests with an API key leave it out.

Path parameters

  • registry_credential_idstringrequired

    ID of the registry credential

    ID with prefix rcr_

Body

JSON (application/json): UpdateRegistryCredentialRequest.

  • namestring

    Its name

    1–100 characters

  • registrystring

    Registry host and optional port, no scheme

    1–260 characters

  • usernamestring

    User name to sign in to the registry with

    1–256 characters

  • passwordstring

    Password or access token. Write-only.

    1–65536 characters

Response

200 RegistryCredential — The updated credentials

  • objectstringrequired

    Always `registry_credential`: the type of this object

    One ofregistry_credential

  • idstringrequired

    Unique ID (`rcr_…`)

    ID with prefix rcr_

  • project_idstringrequired

    Project it belongs to

    ID with prefix prj_

  • namestringrequired

    Its name

  • registrystringrequired

    Registry host and optional port these credentials are for

  • usernamestringrequired

    User name to sign in to the registry with

  • created_by_user_idstring | nullrequired

    ID of the user who created it

  • created_byobject | nullrequired

    Who created it (null: created by the platform)

    Show 3 fields of created_by
    • objectstringrequired

      Always `person`

      One ofperson

    • idstringrequired

      The person’s user ID (`usr_…`)

    • namestring | nullrequired

      Their name as they set it; null when they are no longer a member of the organization

  • created_atstring (date-time)required

    When it was created (ISO 8601, UTC)

  • updated_atstring (date-time)required

    When it last changed (ISO 8601, UTC)

Example response
Example response
{
  "object": "registry_credential",
  "id": "rcr_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "project_id": "prj_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "name": "string",
  "registry": "string",
  "username": "string",
  "created_by_user_id": "string",
  "created_by": {
    "object": "person",
    "id": "string",
    "name": "string"
  },
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Errors

Errors use the standard envelope. What this operation can answer:

Errors
StatusTypeWhen
400invalid_request_errorA parameter or body field is missing or not allowed; param names it.
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
404not_found_errorNo such resource in this project (an ID from another project is answered the same way).
409conflict_errorThe resource's current state does not allow this.
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.