post/vault/credentials/{id}/use

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/vault/credentials/{id}/use
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Credential ID to broker the call with

Request body

agentIdstring

Agent ID (optional when using an agent API key)

method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' required

HTTP method for the outbound call

urlstring uri required

Absolute https:// URL. Its host MUST be on the credential's allowlist.

headersobject

Extra request headers. Any Authorization / auth header is ignored and replaced by the credential.

bodystring

Raw request body (encode JSON yourself).

Response

OK

statusinteger required

Upstream HTTP status code

headersobject required

Upstream response headers

bodystring required

Upstream response body (UTF-8, size-capped)

truncatedboolean required

True if the response body exceeded the size cap and was cut off

Changes

No recorded changes to this operation across all 1 revision of this API.