POST/v1/boards/{id}/api-keys

Mint an ingestion key for a board

Mints a key that writes into ONE custom board with no session behind it — what an outside system posts rows through. Body: name and scopes, at least one of read, rows:write, columns:write, partner, processing. THE ONE ANSWER THAT CARRIES THE SECRET: only its hash is stored, so a lost key is re-minted, never recovered. Manage on the board.

Access class: board:manage.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

idpath · stringrequired

Request body

application/jsonrequired

bodyoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "key": {
      "boardId": "",
      "createdAt": "string",
      "id": "",
      "keyPrefix": "string",
      "name": "string",
      "scopes": [
        "string"
      ]
    },
    "secret": "string"
  }
}

datarequired

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired