connections

POST `/v1/connections/{provider}/{connectionId}/probe`

Re-test a stored credential, one row per permission.

توثيقِ شناخت

ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس connections.manage اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

curl -X POST https://api.zinndigital.com/v1/connections/{provider}/{connectionId}/probe \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں

تفصیلات

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`.

پیرامیٹرز

نام	قسم	لازمی	یہ کیا ہے
`provider (path)`	`ConnectionProvider`	ہاں	The third-party provider whose connections are addressed.
`connectionId (path)`	`Uuid`	ہاں	The MCP connection's id.

درخواست کا باڈی

نام	قسم	لازمی	یہ کیا ہے
`zone_hint`	`string`	نہیں	The domain to test the zone-scoped permissions against. Optional — see `ConnectTokenRequest.zone_hint`.

جواب

نام	قسم	لازمی	یہ کیا ہے
`credential_valid`	`boolean`	ہاں	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 s…
`usable`	`boolean`	ہاں	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[]`	ہاں	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[]`	ہاں	Required permissions the provider proved are absent. Not the unknowns.
`unverified`	`string[]`	ہاں	Permissions we could not determine either way. The honest amber set.
`account_ref`	`string`	ہاں	The account or zone the provider reported — discovered, never assumed.
`detail`	`string`	ہاں	An overall explanation, used mainly for a rejected credential.
`checked_at`	`object`	ہاں	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 custome…

وہ خرابیان جو یہ اینڈ پوائنٹ واپس کر سکتا ہے

401 · 403 · 404 · 422 · 429 · 503

POST /v1/connections/{provider}/{connectionId}/probe