Conventions
What holds across every operation: where to send a call, how the two API versions coexist, what each badge means, and what a failed call returns.
Bases
Three regions, two versions, the same shapes. A call goes to the region your account lives in; this hub shows the EU bases because that is the region it is served from.
Everything is JSON over HTTPS. A path segment in braces is a value you supply — {serviceName} in /hosting/web/{serviceName}.
v1 and v2
Both versions are live and neither replaces the other. A product may expose part of its surface under /v1 and a newer part under /v2.
This hub merges the two per section so you read one list rather than two. Where the same path and method exist in both, the v2 definition is the one shown, and the operation carries a v2 marker. The version also decides the base of its sample.
The v2 schemas are versioned. This reference, the playground and every sample name revision 2026-06 (version 1.0) with the header X-Schemas-Version: 2026-06; a v2 call without it answers in your account's version, which may differ from what is documented here.
Formats
Dates and times follow RFC 3339 on every operation, in UTC or with their offset — 2026-10-06T14:30:00Z, 2026-10-06T16:30:00+02:00. In the reference, a field's format is shown next to its type (date-time) rather than repeated in its description.
Lifecycle
Each operation is badged with its stage, by its title and in the sidebar:
HTTP methods
Five verbs, one badge each — the same badge the sidebar and every operation header carry. This is the legend.
Errors
Responses follow HTTP semantics, and the reference colours them by family: