secrets

Create or version a secret

Create a secret or add a version. Keep the returned version for references in agents and trunks; the response does not return the value.

Use an admin key. Choose sip_auth for a trunk password, webhook_signing for a webhook secret or http_auth for an HTTP credential. The response returns metadata, never the value. Reference the saved secret as {id, version: current_version}.

For a Basis Theory proxy credential, use http_auth and an action.put edit with auth: {scheme: "header", header_name: "BT-PROXY-KEY", secret_ref: {id, version}}. Remove the key query parameter from the action URL and keep the value out of prompts. Proxy access does not grant tokenization permissions.

put/api/v1/secrets/{secret_id}

Request

  • Base URL: https://api.cumuluslabs.io
  • URL: https://api.cumuluslabs.io/api/v1/secrets/{secret_id}
  • Auth: HTTP bearer

Path parameters

secret_idstring required

Headers

Idempotency-Keystring required

Request body

kind'webhook_signing' | 'http_auth' | 'sip_auth' required
valuestring required

Response

Create a secret or add a new version

idstring required
namestring required
kind'webhook_signing' | 'http_auth' | 'sip_auth' required
current_versionstring required
created_atstring date-time required

Changes

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