reseller

GET /v1/reseller/services/{siteId}

One provisioned service.

Alle reseller Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung reseller.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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

Parameter

NameTypErforderlichWas es ist
siteId (path)UuidJaSite ID (UUIDv7).
org_id (query)UuidNeinWhich of your organizations this applies to. Required only when you belong to more than one here.

Antwort

NameTypErforderlichWas es ist
site_idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
client_org_idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
client_org_namestringJa
primary_domainstringJa
namestringNein
statusSiteStatusJaA 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_lineobjectNein
plan_codeobjectNein
plan_nameobjectNein
held_by_resellerbooleanNeinTrue 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_atobjectNeinWhen a scheduled deletion falls due, or null.
sell_amount_minorobjectNeinWhat 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_currencyobjectNein
created_atstringJa
disk_used_bytesobjectNeinNull when the hosting platform has no usage to report for this site.
bandwidth_used_bytesobjectNeinOutbound bandwidth this billing period, or null.
usage_measured_atobjectNeinWhen the reading was taken. Null alongside null usage — so "we have not measured this" is never mistaken for "it used nothing" (§2.44).

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 429