Enable, disable, cap or label one member of a platform key pool

PATCH /v1/platform/credentials/{provider}/{key_id}

Applies the named fields to the active member at the revision If-Match names (1.28.0, workspace ADR 0075). A disabled member serves no new Session and a lower cap admits no Session above it, while running Sessions keep their member; the next admission reads the change. A revoked member, or one of another Provider, is not_found. The Audit event records the fields before and after, never the secret or the hint.

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 PATCH "$VOCAL_API/v1/platform/credentials/mock/plk_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"' \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/platform/credentials/mock/plk_...`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'If-Match': '"1"',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os

import requests

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

Parameters

Request body

Content type application/json, required: PlatformCredentialUpdateRequest.

Responses

Fields of the 200 answer

The shape is PlatformCredential.