Update personal access token Run in API Explorer

PATCH /v2/access-tokens/{uuid}
Bearer auth

Updates a personal access token partially. You can either update the token's label or enable/disable it.

Path parameters

  • uuid string Required
application/json

Body Required

  • token_label string

    Minimum length is 1, maximum length is 100.

  • is_active boolean

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • uuid string
    • client_id string
    • creator_ip string
    • creator_ua string
    • created_at string
    • last_used string | null
    • generated_by string
    • is_active boolean
    • token string
    • token_label string
    • scopes array[string]
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • fields object
    • text string
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • detail string
    • message string
PATCH /v2/access-tokens/{uuid} 
curl \
 --request PATCH 'https://hub.docker.com/v2/access-tokens/{uuid}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"token_label":"My read only token","is_active":false}'
Request examples 
{
  "token_label": "My read only token",
  "is_active": false
}
Response examples (200) 
{
  "uuid": "b30bbf97-506c-4ecd-aabc-842f3cb484fb",
  "client_id": "HUB",
  "creator_ip": "127.0.0.1",
  "creator_ua": "some user agent",
  "created_at": "2021-07-20T12:00:00.000000Z",
  "last_used": "string",
  "generated_by": "manual",
  "is_active": true,
  "token": "a7a5ef25-8889-43a0-8cc7-f2a94268e861",
  "token_label": "My read only token",
  "scopes": [
    "repo:read"
  ]
}
Response examples (400) 
{
  "fields": {},
  "text": "string"
}
Response examples (401) 
{
  "detail": "string",
  "message": "string"
}