Skip to main content

Vault object

Returned by create, get, list, and archive endpoints.
FieldTypeDescription
idstringVault ID with the vault_ prefix
typestringAlways "vault"
display_namestringVault display name, at most 255 characters
statusstringValid values: active, archived
metadataobjectMetadata object
credentialsarray of Vault credentialPresent on create responses when credentials were created in the same request
archived_atstringPresent only when archived
created_atstringCreation time
updated_atstringLast update time

Vault credential

Returned by create credential, list credentials, archive credential, and nested create-vault responses.
FieldTypeDescription
idstringCredential ID with the vcred_ prefix
vault_idstringOwning Vault ID
mcp_server_urlstringMCP server URL, at most 2048 characters
protocolstringSupported value: streamable_http
typestringSupported value: static_bearer
statusstringValid values: active, archived
archived_atstringPresent only when archived
created_atstringCreation time
updated_atstringLast update time
Credential secrets, including access_token, are accepted on create requests but are never returned.

Create credential request

FieldTypeRequiredDescription
mcp_server_urlstringYesMCP server URL, at most 2048 characters
protocolstringYesUse streamable_http
typestringYesUse static_bearer
access_tokenstringYesBearer token stored securely in the Vault

Authenticate with vaults

Store and inject secrets safely into agent sessions.