hosting

GET /v1/bulk-site-imports/template

The columns, allowed values and example file for Add many sites.

All hosting endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The key must carry the sites.create permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/bulk-site-imports/template \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

s1014 BULKUPLOAD. The single source of the upload format: the deploy form's "Many sites" mode renders its "Download example CSV" button and its instructions table from this, so the example file is by construction one the importer accepts. Requires sites.create.

Response

NameTypeRequiredWhat it is
columnsobject[]Yes—
example_csvstringYes—
max_file_bytesintegerYes—
cdn_own_valuestringNoThe cdn value meaning "my own connected CDN account" (named in cdn_account).

Errors this endpoint can return

401 · 403