connections
POST /v1/connections/{provider}/{connectionId}/probe
Re-test a stored credential, one row per permission.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie connections.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X POST https://api.zinndigital.com/v1/connections/{provider}/{connectionId}/probe \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
Exercises every permission we need against the provider using the credential already stored for this connection, and returns one row per permission. This is the "retest" half of add-and-test: the customer's fix happens in their vendor's console — they tick the missing permission at Cloudflare — so there is nothing to re-paste and the stored credential is used. ⛔ It does not ask the credential to describe itself. A least-privilege token cannot enumerate its own permissions, which is how a token missing DNS edit entirely came to be displayed as "works, we will check on first use". Every check here is a real, well-formed call, and a write permission is proved by writing — a throwaway DNS record created and immediately deleted, or a zone setting written back to the value just read. Each row is pass, fail or unknown, and the third is not a nicety: unknown is the honest answer when we could not reach the question — no zone on the account yet, the vendor rate-limiting us, or a well-formed request refused on its content. ⛔ A client that renders unknown as a tick has reintroduced the defect this endpoint exists to remove. The result is stored against the connection with the time it was taken, and returned with checked_at. It is a measurement, not a state — the customer can revoke a permission at their vendor a second later and nothing here will know — so any surface showing it must show its age. Requires connections.manage.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
provider (path) | ConnectionProvider | Tak | The third-party provider whose connections are addressed. |
connectionId (path) | Uuid | Tak | The MCP connection's id. |
Treść żądania
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
zone_hint | string | Nie | The domain to test the zone-scoped permissions against. Optional — see ConnectTokenRequest.zone_hint. |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
credential_valid | boolean | Tak | A statement about the credential, not about the permissions. false means the provider rejected it outright, in which case the rows are not meaningful and the screen must say… |
usable | boolean | Tak | Whether we may store and use this credential: alive, with no proved absence of anything required. ⛔ Deliberately not "every row passed" — a brand-new account with no zone on… |
checks | PermissionCheck[] | Tak | One row per permission, in a stable catalogue order rather than the order the checks happened to finish in — a checklist whose rows reshuffle between two retests looks broken to… |
missing | string[] | Tak | Required permissions the provider proved are absent. Not the unknowns. |
unverified | string[] | Tak | Permissions we could not determine either way. The honest amber set. |
account_ref | string | Tak | The account or zone the provider reported — discovered, never assumed. |
detail | string | Tak | An overall explanation, used mainly for a rejected credential. |
checked_at | object | Tak | When this was taken. ⛔ Never render the report without it: a checklist with no date on it is indistinguishable from a live one and will be read as live, when in fact the customer… |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 422 · 429 · 503