connections
GET /v1/connections/providers
Every provider a customer can connect, with its form and its checklist.
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/connections/providers \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
The **catalogue**: for each connectable provider, which credential fields it takes (and which of them are secret), and which permissions we will test it for. Served as an endpoint rather than baked into each client because the six BYO DNS vendors take credentials of one, two and five fields — ClouDNS needs `auth_id` and `auth_password`, Azure needs five — and hardcoding those in a client duplicates the driver's own `required_settings` across the wire, where the two copies are free to drift apart. Every field name here is read off the driver class itself, so a vendor that gains a required setting changes this response and cannot be connected with a bundle it will refuse. `shapes` is a list of **alternative** credential forms; a client renders the first and offers the rest. Cloudflare is the live case: a scoped API token, or the account email plus its Global API Key. `permissions` is empty when we have no permission model for that provider. ⛔ Render that as "we cannot test this provider's permissions" — **never** as a satisfied (empty) checklist, which is a different and wrong claim. Requires authentication only; it describes what *can* be connected, not what anyone has connected.
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
data | ConnectionProviderDescriptor[] | Sim | — |
Erros que este endpoint pode retornar
401 · 429