Sign in
sites

Create Site

Creates a new site by creating a create_site workflow with deploy_product parameter. This triggers a single workflow that creates the site and deploys the specified upstream.

post/v0/sites

Request body

labelstring required

Site display label

organization_idstring

Organization UUID to associate the site with

regionstring

Geographic region where the site should be hosted

site_namestring required

Site machine name (unique identifier)

upstream_idstring required

Upstream ID (product ID) to deploy

Example request

{
  "label": "My Awesome Site",
  "organization_id": "org-uuid-123",
  "region": "us-east-1",
  "site_name": "my-awesome-site",
  "upstream_id": "e8fe8550-1ab9-4964-8838-2b9abdccf4bf"
}

Response

active_descriptionstring

Active description of current workflow step

created_atnumber double

Creation timestamp

idstring required

Workflow ID

number_of_tasksinteger

Number of tasks in the workflow

typestring

Workflow type

Example response

{
  "active_description": "Starting workflow",
  "created_at": 1234567890,
  "id": "12345678-90ab-cdef-1234-567890abcdef",
  "number_of_tasks": 5,
  "type": "add_site_user_membership"
}