def delete(id, timeout: nil)def delete: (String id, ?timeout: seconds?) -> deleted_key_resourceRevokes a key. The effect is immediate: the next request presenting that secret gets 401. The row is soft-deleted, so the key disappears from list, returns 404 from get, and the id is never reused.
There is no undelete, and the secret was never recoverable in the first place, so ordering matters when you are replacing something that is live. Create the replacement first, deploy it everywhere, confirm lastUsedAt on the old key has stopped advancing, and only then revoke. That sequence gives you an overlap window that an in place rotate would not.
A key cannot revoke itself. Passing the id of the key making the request fails with 409 auth.self_mutation_forbidden, so any automated cleanup has to run under a different credential.
Example
require "envless/sdk"
replacement = Envless.keys.create(
name: "ci-deploy-next",
scopes: {variables: "read"}
)
puts replacement[:prefix]
key_id = "0191f3c2-8a71-7c3e-9b2d-4f5a6c7d8e90"
revoked = Envless.keys.delete(key_id)
puts revoked[:name]Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | String | Yes | The key id, ids only, no prefix and no slug form. |
timeout: | Integer | Float | Rational | No | Seconds each attempt of this call may take, redirects and the response body included, before it raises Envless::NetworkError with timeout? set. Overrides the client's timeout for this call, and 0 turns the limit off. |
Returns
deleted_key_resource with the id and name of the revoked key.
Worth knowing
- The response has no
deletedboolean. That shape belongs towebhooks.delete. - Revoking an already revoked key returns 404
key.not_found, so the call is not idempotent. - Emits
key.deletedto any webhook endpoint subscribed to it.
Required scopes
keys:write
Underlying endpoint
DELETE /keys/{id}
Request and response schema, every error code, and a live playground.
In TypeScript
envless.keys.delete()
The same method in @goenvless/sdk, with the same request, retries and errors.