Skip to content

Update a signing key, mainly its status

patch/v1/projects/{ref}/config/auth/signing-keys/{id}

OAuth scopes

  • secrets:write

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

  • auth_signing_keys_write

Path parameters

  • id
    Required
    string
  • ref
    Required
    string

    Project ref

Body

  • status
    Required
    enum

Response codes

  • 200
  • 401
  • 403
  • 429

Response (200)

{
"id": "00000000-0000-0000-0000-000000000000",
"algorithm": "EdDSA",
"status": "in_use",
"public_jwk": null,
"created_at": "4404-02-29T04:24Z",
"updated_at": "4404-02-29T04:24Z"
}
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"algorithm": {
"type": "string",
"enum": [
"EdDSA",
"ES256",
"RS256",
"HS256"
]
},
"status": {
"type": "string",
"enum": [
"in_use",
"previously_used",
"revoked",
"standby"
]
},
"public_jwk": {
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"algorithm",
"status",
"public_jwk",
"created_at",
"updated_at"
]
}