agency-board
POST /v1/agency/boards/{boardId}/inbound-endpoints/{endpointId}/rotate
Mint a new secret for an inbound endpoint.
Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/inbound-endpoints/{endpointId}/rotate \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
The URL is unchanged — only the secret the sender signs with. That separation is why a rotation is a one-field edit in the sending system rather than a reconfigure.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
boardId (path) | Uuid | Да | Project board ID (UUIDv7). |
endpointId (path) | Uuid | Да | Inbound endpoint ID (UUIDv7). |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Да | — |
endpoint_key | string | Да | The opaque path segment. Not the board id, and unchanged by a secret rotation. |
url | string | Не | The full URL to paste into the sending system. |
signature_scheme | string<zinn, github> | Да | — |
status | BoardAutomationStatus | Да | `suspended` means WE paused it after repeated failure and it carries a reason the customer has not read. It is a third state rather than a reuse of `disabled`, because collapsin… |
has_secret | boolean | Да | — |
request_count | integer | Не | — |
rejected_count | integer | Не | — |
last_rejection | string | Не | Why the last refused request was refused — so "my n8n node says 404" is answerable from this screen rather than from a support ticket. |
last_seen_at | string | Не | — |
created_at | string | Не | — |
secret | string | Да | Shown ONCE, here. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422