Revoke the active platform credential of a Provider

DELETE /v1/platform/credentials/{provider}

Revokes the active version If-Match names and answers it with status revoked; with * it revokes every active member of the Provider's key pool (1.28.0; before it, the one active version) and answers the newest of them. not_found when the Provider has no active credential. Running Sessions keep the secret they were issued; once no enabled member is left, the worker uses its environment key for the Provider's next Sessions.

Request

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

curl -X DELETE "$VOCAL_API/v1/platform/credentials/mock" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"'

const response = await fetch(`${process.env.VOCAL_API}/v1/platform/credentials/mock`, {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'If-Match': '"1"',
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.delete(
    f"{os.environ['VOCAL_API']}/v1/platform/credentials/mock",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "If-Match": '"1"',
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is PlatformCredential.