Skip to main content
DELETE
Soft delete a credential reference

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Headers

x-tenant-id
string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1
x-organization-id
string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Path Parameters

vaultId
string<uuid>
required

Vault id (UUID) that owns the credential.

credentialId
string<uuid>
required

Credential reference id (UUID) within the vault, as returned by managedAgentsListVaultCredentials.

Response

Shared response body of every soft-delete endpoint, on agents, environments, tags, vaults, vault credentials, webhook bindings, and sessions. Soft delete is a tombstone, not an erase: the row stops appearing in list and get responses but is retained, and there is no undelete endpoint to bring it back. Irreversible erasure is the separate, confirmation-gated purge path.

Shared response body of every soft-delete endpoint, on agents, environments, tags, vaults, vault credentials, webhook bindings, and sessions. Soft delete is a tombstone, not an erase: the row stops appearing in list and get responses but is retained, and there is no undelete endpoint to bring it back. Irreversible erasure is the separate, confirmation-gated purge path.

deleted
boolean
required

Always true. The record was soft deleted and is now excluded from reads; a delete that did not happen is an HTTP error instead, so this field never reports false.