reseller

GET /v1/reseller/services/{siteId}

One provisioned service.

Все эндпоинты reseller

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение reseller.view; ключ без него отклоняется с кодом 403, а не 404.

Идентификатор вашей организации

Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.

Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X GET https://api.zinndigital.com/v1/reseller/services/{siteId} \
  -H "Authorization: Bearer zdk_live_…"

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

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

Параметры

ИмяТипОбязательноЧто это
siteId (path)UuidДаSite ID (UUIDv7).
org_id (query)UuidНетWhich of your organizations this applies to. Required only when you belong to more than one here.

Ответ

ИмяТипОбязательноЧто это
site_idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
client_org_idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
client_org_namestringДа
primary_domainstringДа
namestringНет
statusSiteStatusДаA 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_lineobjectНет
plan_codeobjectНет
plan_nameobjectНет
held_by_resellerbooleanНетTrue 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_atobjectНетWhen a scheduled deletion falls due, or null.
sell_amount_minorobjectНетWhat 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_currencyobjectНет
created_atstringДа
disk_used_bytesobjectНетNull when the hosting platform has no usage to report for this site.
bandwidth_used_bytesobjectНетOutbound bandwidth this billing period, or null.
usage_measured_atobjectНетWhen the reading was taken. Null alongside null usage — so "we have not measured this" is never mistaken for "it used nothing" (§2.44).

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 429