Skip to content
Management API Reference

Updates an API key for the project

patch/v1/projects/{ref}/api-keys/{id}

OAuth scopes

  • secrets:write

The fine-grained token must include the following permissions to access this endpoint:

  • api_gateway_keys_write

Path parameters

  • ref
    Required
    string

    Project ref

  • id
    Required
    string

Query parameters

  • reveal
    Optional
    string

    Boolean string.

    Truthy values: true, 1, yes, on, y, enabled

    Falsy values: false, 0, no, off, n, disabled

Body

  • name
    Optional
    string
  • description
    Optional
    string
  • secret_jwt_template
    Optional
    object

Response codes

  • 200
  • 401
  • 403
  • 429

Response (200)

{
  "api_key": "lorem",
  "id": "lorem",
  "type": "legacy",
  "prefix": "lorem",
  "name": "lorem",
  "description": "lorem",
  "hash": "lorem",
  "secret_jwt_template": {
    "property1": null,
    "property2": null
  },
  "inserted_at": "4404-02-29T04:24Z",
  "updated_at": "4404-02-29T04:24Z"
}