Skip to main content
PATCH
Rename a credential, rotate its reference, or change its egress bounds

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.

Body

application/json
displayName
string

Replacement operator-facing label. Omit to keep the current one.

Maximum string length: 256
integrationPermission
string

Replacement permission preset for an integration grant.

integrationResources
string[]

Replacement resource allowlist for an integration grant.

metadata
object

Replacement caller-owned labels. Omit to keep the current object.

secretName
string

Replacement environment variable or header name. Omit to keep the current one.

secretRef
string

New secret-manager reference. Omit to keep the current secret.

secretValue
string
write-only

Replacement credential material. Omit to keep the current secret.

Response

OK

createdAt
string<date-time>
required
read-only

Server-assigned RFC 3339 creation time.

credentialId
string
required
read-only

Server-assigned credential identifier (UUID), unique within the vault.

credentialType
string
required

How the credential is used. Legacy rows may report additional kinds.

organizationId
string
required
read-only

Organization that owns this record, resolved from the authenticated principal.

updatedAt
string<date-time>
required
read-only

Server-assigned RFC 3339 last update time.

vaultId
string
required
read-only

Vault that owns this credential (UUID).

allowedHosts
string[]

IMAP credentials only: exactly one immutable lowercase mail-server hostname, without a wildcard, scheme, port, or path. Required on create and enforced before authentication.

Required array length: 1 element
Pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)*$
displayName
string

Optional operator-facing credential label.

integrationConnectionId
string

Organization integration connection granted by this credential (UUID).

integrationPermission
string

Validated provider permission preset.

integrationResources
string[]

Provider resources the integration grant is narrowed to.

mcpServerUrl
string

MCP server this credential may be sent to.

metadata
object

Caller-supplied labels, with compatibility-only scope data excluded.

platformMcpService
enum<string>
read-only

Deployment-derived identity of an exact platform MCP service; never caller-controlled or stored.

Available options:
slack_tools
provider
enum<string>

Catalog service for a proxied env_var credential, absent for credentials supplied directly to the sandbox.

Available options:
anthropic,
github_packages_npm,
openai,
slack,
stripe
secretName
string

Environment variable or header name the secret binds to.

secretRef
string

Opaque pointer to externally stored secret material.