Skip to content
Management API Reference

Updates an API key for the project

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

OAuth scopes

  • secrets:write

Path parameters

  • ref
    Required
    string

    Project ref

  • id
    Required
    string

Query parameters

  • reveal
    Optional
    boolean

    Boolean string, true or false

Body

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

Response codes

  • 200
  • 401
  • 403
  • 429

Response (200)

1
{
2
  "api_key": "lorem",
3
  "id": "lorem",
4
  "type": "legacy",
5
  "prefix": "lorem",
6
  "name": "lorem",
7
  "description": "lorem",
8
  "hash": "lorem",
9
  "secret_jwt_template": {
10
    "property1": null,
11
    "property2": null
12
  },
13
  "inserted_at": "2021-12-31T23:34:00Z",
14
  "updated_at": "2021-12-31T23:34:00Z"
15
}