VocalDocscontracts 1.65.0

List the platform credential versions, masked

GET /v1/platform/credentials

PropertyValue
Operationlist_platform_credentials
GroupPlatform
Scopeplatform:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A masked configuration read; no secret is returned.
Released in1.10.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Every version of every Provider credential, newest first, with its last four characters and status; never a secret. From 1.28.0 each version is a member of its Provider key pool, with its id, enable switch, cap, revision and the count of the Sessions it serves now.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the platform:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/platform/credentials" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.

Responses

StatusContent typeShapeError codes
200application/jsonPlatformCredentialList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is PlatformCredentialList.

FieldTypeRequiredDescription
dataarray of PlatformCredentialyesThe platform credential versions of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes