cdnca

API reference

/v1/control-site

3 operations

← All groups · First call? Read the tutorial: auth, permissions, requests and responses, common failures

MethodPathSummaryAuth
GET/v1/control-site/assets/{sha256}—Public
GET/v1/control-site/content—Public
GET/v1/control-site/packages—Public

Contract file：api/control-site-website.openapi.yaml

Operation details

GET /v1/control-site/assets/{sha256}

operationId
readControlSiteAsset
Auth
  • No authentication.
Required permissions

The contract has no separate permission annotation; see the description below and the 403 response.

Description (from the contract)

An uploaded image, a built-in illustration or a website theme plugin image; immutable, served with a sandboxing CSP.

Parameters

readControlSiteAsset Parameters
NameInTypeRequiredDescription
sha256pathstringYes—

Responses

readControlSiteAsset Responses
StatusDescription
200Image bytes
304Not modified
404Not found

What to do on failure

  • 404 The resource does not exist or belongs to another tenant.

↑ Back to list

GET /v1/control-site/content

operationId
readControlSiteContent
Auth
  • No authentication.
Required permissions

The contract has no separate permission annotation; see the description below and the 403 response.

Description (from the contract)

The published website as the active plugin lays it out; {schema, enabled:false} while nothing is published.

Responses

readControlSiteContent Responses
StatusDescription
200Published view

Fields：nav?: array<object> | null actions?: array<Link> | null footer?: object pages?: array<object> | null schema?: const cdnca.control-site/v1 enabled?: boolean layout?: string: jidun / xmf theme?: ThemeView brand?: Brand contact?: Contact

304Not modified
503Unavailable

What to do on failure

  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list

GET /v1/control-site/packages

operationId
listControlSitePackages
Auth
  • No authentication.
Required permissions

The contract has no separate permission annotation; see the description below and the 403 response.

Description (from the contract)

The platform's purchasable packages for the website's plan blocks (fix-sitepricing): published, enabled, in visible groups and on sale, in package sort order, at most 24. Display fields only (no product ID, CNAME, region or purchase policy); -1 limits mean unlimited, prices are minor units of prices.currency. Empty when none are on sale.

Responses

listControlSitePackages Responses
StatusDescription
200Package list

Fields：items: array<object>

503Unavailable

What to do on failure

  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list