Add a member to a Provider's platform key pool

POST /v1/platform/credentials/{provider}

Seals the secret as the Provider's next credential version, enabled, beside the active ones, none of which is revoked (1.28.0, workspace ADR 0075). At admission the api takes, among the enabled members below their cap, the one with the fewest concurrent Sessions, ties broken at random, so a new member takes Sessions at once. The request body is never logged, never stored in clear and never returned; the response and the Audit event name the Provider, the member's id and the version only. A Provider whose descriptors declare no credential mode is refused with validation_failed. The ETag is the member's revision.

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 POST "$VOCAL_API/v1/platform/credentials/mock" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{ "secret": "<secret>" }'

const response = await fetch(`${process.env.VOCAL_API}/v1/platform/credentials/mock`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "secret": "<secret>"
  }),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/platform/credentials/mock",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "secret": "<secret>",
    },
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: PlatformCredentialAddRequest.

Responses

Fields of the 201 answer

The shape is PlatformCredential.