reseller

GET /v1/reseller/services/{siteId}

One provisioned service.

Todos os endpoints de reseller

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão reseller.view; uma chave sem ela é recusada com 403, e não 404.

Onde vai o ID da sua organização

Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

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/reseller/services/{siteId} \
  -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 same row `listResellerServices` returns, for one site. A site outside your client subtree is a 404, never a 403 — so this is not an existence oracle. Requires `reseller.view`.

Parâmetros

NomeTipoObrigatórioO que é
siteId (path)UuidSimSite ID (UUIDv7).
org_id (query)UuidNãoWhich of your organizations this applies to. Required only when you belong to more than one here.

Resposta

NomeTipoObrigatórioO que é
site_idUuidSimUUIDv7 identifier — sortable by creation time (docs/02 §8).
client_org_idUuidSimUUIDv7 identifier — sortable by creation time (docs/02 §8).
client_org_namestringSim
primary_domainstringSim
namestringNão
statusSiteStatusSimA site's lifecycle state (docs/04 §3). A newly created site is `pending` until the provisioning workflow picks it up; `deleted` is terminal. `restricted` and `quarantined` are t…
product_lineobjectNão
plan_codeobjectNão
plan_nameobjectNão
held_by_resellerbooleanNãoTrue when the current suspension was placed through this surface, which is the only case `unsuspendResellerService` will release. A site suspended by the abuse desk reports fals…
pending_deletion_atobjectNãoWhen a scheduled deletion falls due, or null.
sell_amount_minorobjectNãoWhat YOU charge for this plan, in minor units of `sell_currency` — your own price-list row if you have authored one, otherwise our list price with your default markup applied. N…
sell_currencyobjectNão
created_atstringSim
disk_used_bytesobjectNãoNull when the hosting platform has no usage to report for this site.
bandwidth_used_bytesobjectNãoOutbound bandwidth this billing period, or null.
usage_measured_atobjectNãoWhen the reading was taken. Null alongside null usage — so "we have not measured this" is never mistaken for "it used nothing" (§2.44).

Erros que este endpoint pode retornar

401 · 403 · 404 · 429