PATCH/security/keys/{uuid}

Update a private key

Updates the name, description, or private key value for an existing private key. Include only the fields you want to change. The response includes the UUID of the updated key.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
uuidstringrequired
The UUID of the private key to update.

Private key fields to update. All fields are optional.

descriptionstringoptional
The updated description for the private key.
namestringoptional
The updated name for the private key.
private_keystringoptional
The updated private key value.

5 status codes
201Returns the UUID of the updated private key.
uuidstringoptional
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
404Returned when the private key is not found.
422Returned when the request fails validation.
errorsobjectoptional
messagestringoptional

Error handling

A 400 is returned when the token is invalid. A 401 is returned when the request is unauthenticated. A 404 is returned when the private key is not found, and a 422 is returned when the submitted fields fail validation. The uuid path parameter must identify the private key to update.