API by router
Websites
GET
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
Per-instance website configuration.
content_mode?Content ModeDefault
"bundle"created_at*Created AtFormat
date-timecustom_upload_id?|nullcustomer_id?|nulldeployed_at?|nulldeployed_instance_id?|nullfaq?array<unknown>Default
[]features?array<unknown>Default
[]hero_cta_text?string|nullhero_subtitle?string|nullhero_title?string|nullid*IdFormat
uuidinstance_id?|nullis_primary?Is PrimaryDefault
truepricing_currency?Pricing CurrencyDefault
"USD"pricing_plans?array<unknown>Default
[]robots_txt_custom?string|nullseo_description?string|nullseo_keywords?string|nullseo_og_image_url?string|nullseo_title?string|nullsitemap_enabled?Sitemap EnabledDefault
truestatus?StatusDefault
"draft"stripe_connect_account_id?string|nullstripe_publishable_key?string|nulltemplate_id?|nulltenant_id*Tenant IdFormat
uuidtestimonials?array<unknown>Default
[]trial_days?Trial DaysDefault
14updated_at*Updated AtFormat
date-timecurl -X GET 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/website'Example Response
{ "content_mode": "bundle", "created_at": "2019-08-24T14:15:22Z", "custom_upload_id": "32c143b7-3420-4cb9-8ea3-6d8d9a659ee2", "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "deployed_at": "2019-08-24T14:15:22Z", "deployed_instance_id": "5d02be4a-43b3-42f1-9872-f2bfe2e6f121", "faq": [], "features": [], "hero_cta_text": "string", "hero_subtitle": "string", "hero_title": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "is_primary": true, "pricing_currency": "USD", "pricing_plans": [], "robots_txt_custom": "string", "seo_description": "string", "seo_keywords": "string", "seo_og_image_url": "string", "seo_title": "string", "sitemap_enabled": true, "status": "draft", "stripe_connect_account_id": "string", "stripe_publishable_key": "string", "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc", "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0", "testimonials": [], "trial_days": 14, "updated_at": "2019-08-24T14:15:22Z"}PUT
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullapplication/json- body
Partial update for website config.
"You can't handle the truth!" — Col. Jessup (about SEO meta descriptions exceeding 160 chars)
content_mode?|nullcustom_upload_id?|nullcustomer_id?|nullfaq?array<unknown>|nullfeatures?array<unknown>|nullhero_cta_text?|nullhero_subtitle?|nullhero_title?|nullis_primary?boolean|nullpricing_currency?|nullpricing_plans?array<unknown>|nullrobots_txt_custom?string|nullseo_description?|nullseo_keywords?|nullseo_og_image_url?string|nullseo_title?|nullsitemap_enabled?boolean|nullstripe_connect_account_id?|nullstripe_publishable_key?|nulltemplate_id?|nulltestimonials?array<unknown>|nulltrial_days?|nullSuccessful Response
application/json- response
Per-instance website configuration.
content_mode?Content ModeDefault
"bundle"created_at*Created AtFormat
date-timecustom_upload_id?|nullcustomer_id?|nulldeployed_at?|nulldeployed_instance_id?|nullfaq?array<unknown>Default
[]features?array<unknown>Default
[]hero_cta_text?string|nullhero_subtitle?string|nullhero_title?string|nullid*IdFormat
uuidinstance_id?|nullis_primary?Is PrimaryDefault
truepricing_currency?Pricing CurrencyDefault
"USD"pricing_plans?array<unknown>Default
[]robots_txt_custom?string|nullseo_description?string|nullseo_keywords?string|nullseo_og_image_url?string|nullseo_title?string|nullsitemap_enabled?Sitemap EnabledDefault
truestatus?StatusDefault
"draft"stripe_connect_account_id?string|nullstripe_publishable_key?string|nulltemplate_id?|nulltenant_id*Tenant IdFormat
uuidtestimonials?array<unknown>Default
[]trial_days?Trial DaysDefault
14updated_at*Updated AtFormat
date-timecurl -X PUT 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/website' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "content_mode": "bundle", "created_at": "2019-08-24T14:15:22Z", "custom_upload_id": "32c143b7-3420-4cb9-8ea3-6d8d9a659ee2", "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "deployed_at": "2019-08-24T14:15:22Z", "deployed_instance_id": "5d02be4a-43b3-42f1-9872-f2bfe2e6f121", "faq": [], "features": [], "hero_cta_text": "string", "hero_subtitle": "string", "hero_title": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "is_primary": true, "pricing_currency": "USD", "pricing_plans": [], "robots_txt_custom": "string", "seo_description": "string", "seo_keywords": "string", "seo_og_image_url": "string", "seo_title": "string", "sitemap_enabled": true, "status": "draft", "stripe_connect_account_id": "string", "stripe_publishable_key": "string", "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc", "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0", "testimonials": [], "trial_days": 14, "updated_at": "2019-08-24T14:15:22Z"}POST
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
Response after initiating website deployment.
instance_id?|nullmessage*Messagestatus*Statuswebsite_config_id*Website Config IdFormat
uuidcurl -X POST 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/website/deploy'Example Response
{ "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "message": "string", "status": "string", "website_config_id": "c0aa0662-77a9-4227-8f52-c7a29b8a3ad3"}GET
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
[index: integer]?curl -X GET 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/website/history'Example Response
[ { "artifact_hash": "string", "change_source": "string", "commit_sha": "string", "created_at": "2019-08-24T14:15:22Z", "deployed_at": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "notes": "string", "release_id": "string", "status": "string" }]GET
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
Preview payload: config + brand + template merged for client-side rendering.
brand?Default
{}content?Default
{}content_mode?Content ModeDefault
"bundle"custom_upload?Custom UploadDefault
falsepricing?Default
{}seo?Default
{}template_name?string|nulltemplate_slug?string|nullcurl -X GET 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/website/preview'Example Response
{ "brand": {}, "content": {}, "content_mode": "bundle", "custom_upload": false, "pricing": {}, "seo": {}, "template_name": "string", "template_slug": "string"}POST
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullapplication/json- body
git_ref?|nullrelease_id?|nullSuccessful Response
application/json- response
Response after initiating website deployment.
instance_id?|nullmessage*Messagestatus*Statuswebsite_config_id*Website Config IdFormat
uuidcurl -X POST 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/website/rollback' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "message": "string", "status": "string", "website_config_id": "c0aa0662-77a9-4227-8f52-c7a29b8a3ad3"}POST
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullmultipart/form-data- body
file*FileFormat
binarySuccessful Response
application/json- response
Custom site upload metadata.
content_type*Content Typecreated_at*Created AtFormat
date-timedetected_framework?string|nullfilename*Filenamehas_index_html*Has Index Htmlhas_package_json*Has Package Jsonid*IdFormat
uuidis_active*Is Activepreview_url?string|nullscan_findings?array<unknown>Default
[]scan_status?Scan StatusDefault
"pending"scan_threat_level?string|nullsha256_hash*Sha256 Hashsize_bytes*Size Bytestenant_id*Tenant IdFormat
uuidvalidation_errors?array<unknown>Default
[]validation_status*Validation Statuscurl -X POST 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/website/upload' \ -F 'file=string'Example Response
{ "content_type": "string", "created_at": "2019-08-24T14:15:22Z", "detected_framework": "string", "filename": "string", "has_index_html": true, "has_package_json": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "is_active": true, "preview_url": "string", "scan_findings": [], "scan_status": "pending", "scan_threat_level": "string", "sha256_hash": "string", "size_bytes": 0, "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0", "validation_errors": [], "validation_status": "string"}GET
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
[index: integer]?Custom site upload metadata.
curl -X GET 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/website/uploads'Example Response
[ { "content_type": "string", "created_at": "2019-08-24T14:15:22Z", "detected_framework": "string", "filename": "string", "has_index_html": true, "has_package_json": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "is_active": true, "preview_url": "string", "scan_findings": [], "scan_status": "pending", "scan_threat_level": "string", "sha256_hash": "string", "size_bytes": 0, "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0", "validation_errors": [], "validation_status": "string" }]GET
HTTPBearerheader
AuthorizationBearer <token>customer_id?|Filter by customer owner
X-Api-Key?string|nullSuccessful Response
application/json- response
[index: integer]?Per-instance website configuration.
curl -X GET 'https://example.com/v1/website'Example Response
[ { "content_mode": "bundle", "created_at": "2019-08-24T14:15:22Z", "custom_upload_id": "32c143b7-3420-4cb9-8ea3-6d8d9a659ee2", "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "deployed_at": "2019-08-24T14:15:22Z", "deployed_instance_id": "5d02be4a-43b3-42f1-9872-f2bfe2e6f121", "faq": [], "features": [], "hero_cta_text": "string", "hero_subtitle": "string", "hero_title": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "is_primary": true, "pricing_currency": "USD", "pricing_plans": [], "robots_txt_custom": "string", "seo_description": "string", "seo_keywords": "string", "seo_og_image_url": "string", "seo_title": "string", "sitemap_enabled": true, "status": "draft", "stripe_connect_account_id": "string", "stripe_publishable_key": "string", "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc", "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0", "testimonials": [], "trial_days": 14, "updated_at": "2019-08-24T14:15:22Z" }]PUT
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullapplication/json- body
Partial update for website config.
"You can't handle the truth!" — Col. Jessup (about SEO meta descriptions exceeding 160 chars)
content_mode?|nullcustom_upload_id?|nullcustomer_id?|nullfaq?array<unknown>|nullfeatures?array<unknown>|nullhero_cta_text?|nullhero_subtitle?|nullhero_title?|nullis_primary?boolean|nullpricing_currency?|nullpricing_plans?array<unknown>|nullrobots_txt_custom?string|nullseo_description?|nullseo_keywords?|nullseo_og_image_url?string|nullseo_title?|nullsitemap_enabled?boolean|nullstripe_connect_account_id?|nullstripe_publishable_key?|nulltemplate_id?|nulltestimonials?array<unknown>|nulltrial_days?|nullSuccessful Response
application/json- response
Per-instance website configuration.
content_mode?Content ModeDefault
"bundle"created_at*Created AtFormat
date-timecustom_upload_id?|nullcustomer_id?|nulldeployed_at?|nulldeployed_instance_id?|nullfaq?array<unknown>Default
[]features?array<unknown>Default
[]hero_cta_text?string|nullhero_subtitle?string|nullhero_title?string|nullid*IdFormat
uuidinstance_id?|nullis_primary?Is PrimaryDefault
truepricing_currency?Pricing CurrencyDefault
"USD"pricing_plans?array<unknown>Default
[]robots_txt_custom?string|nullseo_description?string|nullseo_keywords?string|nullseo_og_image_url?string|nullseo_title?string|nullsitemap_enabled?Sitemap EnabledDefault
truestatus?StatusDefault
"draft"stripe_connect_account_id?string|nullstripe_publishable_key?string|nulltemplate_id?|nulltenant_id*Tenant IdFormat
uuidtestimonials?array<unknown>Default
[]trial_days?Trial DaysDefault
14updated_at*Updated AtFormat
date-timecurl -X PUT 'https://example.com/v1/website' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "content_mode": "bundle", "created_at": "2019-08-24T14:15:22Z", "custom_upload_id": "32c143b7-3420-4cb9-8ea3-6d8d9a659ee2", "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "deployed_at": "2019-08-24T14:15:22Z", "deployed_instance_id": "5d02be4a-43b3-42f1-9872-f2bfe2e6f121", "faq": [], "features": [], "hero_cta_text": "string", "hero_subtitle": "string", "hero_title": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "is_primary": true, "pricing_currency": "USD", "pricing_plans": [], "robots_txt_custom": "string", "seo_description": "string", "seo_keywords": "string", "seo_og_image_url": "string", "seo_title": "string", "sitemap_enabled": true, "status": "draft", "stripe_connect_account_id": "string", "stripe_publishable_key": "string", "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc", "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0", "testimonials": [], "trial_days": 14, "updated_at": "2019-08-24T14:15:22Z"}POST
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullapplication/json- body
Request to deploy website to an instance.
instance_id is optional — if provided, deploys the config linked to that instance. If omitted, picks the most recent unlinked draft config. "Get to the chopper!" — Dutch, Predator (about deploying to VPS)
instance_id?|nullpreset_id?Preset IdDefault
"support_agent"region_id*Region Idtier_id*Tier IdSuccessful Response
application/json- response
Response after initiating website deployment.
instance_id?|nullmessage*Messagestatus*Statuswebsite_config_id*Website Config IdFormat
uuidcurl -X POST 'https://example.com/v1/website/deploy' \ -H 'Content-Type: application/json' \ -d '{ "region_id": "string", "tier_id": "string"}'Example Response
{ "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "message": "string", "status": "string", "website_config_id": "c0aa0662-77a9-4227-8f52-c7a29b8a3ad3"}GET
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullSuccessful Response
application/json- response
Preview payload: config + brand + template merged for client-side rendering.
brand?Default
{}content?Default
{}content_mode?Content ModeDefault
"bundle"custom_upload?Custom UploadDefault
falsepricing?Default
{}seo?Default
{}template_name?string|nulltemplate_slug?string|nullcurl -X GET 'https://example.com/v1/website/preview'Example Response
{ "brand": {}, "content": {}, "content_mode": "bundle", "custom_upload": false, "pricing": {}, "seo": {}, "template_name": "string", "template_slug": "string"}POST
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullmultipart/form-data- body
file*FileFormat
binarySuccessful Response
application/json- response
Custom site upload metadata.
content_type*Content Typecreated_at*Created AtFormat
date-timedetected_framework?string|nullfilename*Filenamehas_index_html*Has Index Htmlhas_package_json*Has Package Jsonid*IdFormat
uuidis_active*Is Activepreview_url?string|nullscan_findings?array<unknown>Default
[]scan_status?Scan StatusDefault
"pending"scan_threat_level?string|nullsha256_hash*Sha256 Hashsize_bytes*Size Bytestenant_id*Tenant IdFormat
uuidvalidation_errors?array<unknown>Default
[]validation_status*Validation Statuscurl -X POST 'https://example.com/v1/website/upload' \ -F 'file=string'Example Response
{ "content_type": "string", "created_at": "2019-08-24T14:15:22Z", "detected_framework": "string", "filename": "string", "has_index_html": true, "has_package_json": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "is_active": true, "preview_url": "string", "scan_findings": [], "scan_status": "pending", "scan_threat_level": "string", "sha256_hash": "string", "size_bytes": 0, "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0", "validation_errors": [], "validation_status": "string"}GET
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullSuccessful Response
application/json- response
[index: integer]?Custom site upload metadata.
curl -X GET 'https://example.com/v1/website/uploads'Example Response
[ { "content_type": "string", "created_at": "2019-08-24T14:15:22Z", "detected_framework": "string", "filename": "string", "has_index_html": true, "has_package_json": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "is_active": true, "preview_url": "string", "scan_findings": [], "scan_status": "pending", "scan_threat_level": "string", "sha256_hash": "string", "size_bytes": 0, "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0", "validation_errors": [], "validation_status": "string" }]