HydraCore
API by router

Templates

List Templates

GET
/v1/templates

Query Parameters

limit?Limit
Range1 <= value <= 100
Default50
offset?Offset
Range0 <= value
Default0

Response Body

Successful Response

application/json
  1. response
[index: integer]?

Website template from the platform catalog.

Example Request
curl -X GET 'https://example.com/v1/templates'
Example Response
[  {    "custom_upload_id": "32c143b7-3420-4cb9-8ea3-6d8d9a659ee2",    "default_content": {},    "default_integrations": [],    "default_seo_description": "string",    "default_seo_title": "string",    "default_skills": [],    "description": "string",    "display_order": 0,    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "preview_image_url": "string",    "preview_urls": [],    "rendering_mode": "string",    "scope": "platform",    "security_status": "clean",    "slug": "string",    "source_type": "builtin",    "status": "active",    "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",    "vertical": "string",    "visibility": "customer"  }]
GET
/v1/templates/gallery

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Query Parameters

limit?Limit
Range1 <= value <= 100
Default50
offset?Offset
Range0 <= value
Default0

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
[index: integer]?

Website template from the platform catalog.

Example Request
curl -X GET 'https://example.com/v1/templates/gallery'
Example Response
[  {    "custom_upload_id": "32c143b7-3420-4cb9-8ea3-6d8d9a659ee2",    "default_content": {},    "default_integrations": [],    "default_seo_description": "string",    "default_seo_title": "string",    "default_skills": [],    "description": "string",    "display_order": 0,    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "preview_image_url": "string",    "preview_urls": [],    "rendering_mode": "string",    "scope": "platform",    "security_status": "clean",    "slug": "string",    "source_type": "builtin",    "status": "active",    "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",    "vertical": "string",    "visibility": "customer"  }]
POST
/v1/templates/gallery/{template_id}/instantiate

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

template_id*Template Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
bootstrap_release?Bootstrap Release
Defaultfalse
customer_id?|null
dedicated_instance_id?|null
hosting_mode?Hosting Mode
Match^(draft|shared|dedicated)$
Default"draft"
primary_domain?|null
site_name?|null
webhost_node_id?|null

Response Body

Successful Response

application/json
  1. response
deploy_task_id?string|null
hosted_website_id?|null
hosting_mode*Hosting Mode
selected_node_id?|null
website_config*

Per-instance website configuration.

Example Request
curl -X POST 'https://example.com/v1/templates/gallery/497f6eca-6276-4993-bfeb-53cbbbba6f08/instantiate' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "deploy_task_id": "string",  "hosted_website_id": "2e68090f-4b97-4f89-8ca4-5adeb58dde95",  "hosting_mode": "string",  "selected_node_id": "d14898b8-4f35-412a-8e47-dd691a362904",  "website_config": {    "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"  }}
GET
/v1/templates/gallery/{template_id}/preview

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

template_id*Template Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
generated?Generated
Defaulttrue
id*Id
Formatuuid
name*Name
preview_html*Preview Html
preview_image_url?string|null
preview_urls?array<string>
Default[]
slug*Slug
Example Request
curl -X GET 'https://example.com/v1/templates/gallery/497f6eca-6276-4993-bfeb-53cbbbba6f08/preview'
Example Response
{  "generated": true,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "preview_html": "string",  "preview_image_url": "string",  "preview_urls": [],  "slug": "string"}

Import Template From Upload

POST
/v1/templates/import

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
description?|null
name*Name
Length1 <= length <= 200
preview_image_url?|null
preview_urls?array<>
Itemsitems <= 8
rendering_mode?Rendering Mode
Match^(ssr|static|spa)$
Default"static"
upload_id*Upload Id
Formatuuid
vertical*Vertical

Business vertical — free-text, used for filtering/suggestions

Lengthlength <= 50
visibility?Visibility
Match^(private|customer)$
Default"private"

Response Body

Successful Response

application/json
  1. response

Website template from the platform catalog.

custom_upload_id?|null
default_content?
Default{}
default_integrations?array<unknown>
Default[]
default_seo_description?string|null
default_seo_title?string|null
default_skills?array<unknown>
Default[]
description?string|null
display_order*Display Order
id*Id
Formatuuid
name*Name
preview_image_url?string|null
preview_urls?array<unknown>
Default[]
rendering_mode*Rendering Mode
scope?Scope
Default"platform"
security_status?Security Status
Default"clean"
slug*Slug
source_type?Source Type
Default"builtin"
status?Status
Default"active"
tenant_id?|null
vertical*Vertical
visibility?Visibility
Default"customer"
Example Request
curl -X POST 'https://example.com/v1/templates/import' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",  "vertical": "string"}'
Example Response
{  "custom_upload_id": "32c143b7-3420-4cb9-8ea3-6d8d9a659ee2",  "default_content": {},  "default_integrations": [],  "default_seo_description": "string",  "default_seo_title": "string",  "default_skills": [],  "description": "string",  "display_order": 0,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "preview_image_url": "string",  "preview_urls": [],  "rendering_mode": "string",  "scope": "platform",  "security_status": "clean",  "slug": "string",  "source_type": "builtin",  "status": "active",  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",  "vertical": "string",  "visibility": "customer"}

Update Tenant Template

PATCH
/v1/templates/library/{template_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

template_id*Template Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
description?|null
is_active?boolean|null
name?|null
preview_image_url?|null
preview_urls?array<>|null
vertical?|null
visibility?|null

Response Body

Successful Response

application/json
  1. response

Website template from the platform catalog.

custom_upload_id?|null
default_content?
Default{}
default_integrations?array<unknown>
Default[]
default_seo_description?string|null
default_seo_title?string|null
default_skills?array<unknown>
Default[]
description?string|null
display_order*Display Order
id*Id
Formatuuid
name*Name
preview_image_url?string|null
preview_urls?array<unknown>
Default[]
rendering_mode*Rendering Mode
scope?Scope
Default"platform"
security_status?Security Status
Default"clean"
slug*Slug
source_type?Source Type
Default"builtin"
status?Status
Default"active"
tenant_id?|null
vertical*Vertical
visibility?Visibility
Default"customer"
Example Request
curl -X PATCH 'https://example.com/v1/templates/library/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "custom_upload_id": "32c143b7-3420-4cb9-8ea3-6d8d9a659ee2",  "default_content": {},  "default_integrations": [],  "default_seo_description": "string",  "default_seo_title": "string",  "default_skills": [],  "description": "string",  "display_order": 0,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "preview_image_url": "string",  "preview_urls": [],  "rendering_mode": "string",  "scope": "platform",  "security_status": "clean",  "slug": "string",  "source_type": "builtin",  "status": "active",  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",  "vertical": "string",  "visibility": "customer"}

Get Template

GET
/v1/templates/{slug}

Path Parameters

slug*Slug

Response Body

Successful Response

application/json
  1. response

Website template from the platform catalog.

custom_upload_id?|null
default_content?
Default{}
default_integrations?array<unknown>
Default[]
default_seo_description?string|null
default_seo_title?string|null
default_skills?array<unknown>
Default[]
description?string|null
display_order*Display Order
id*Id
Formatuuid
name*Name
preview_image_url?string|null
preview_urls?array<unknown>
Default[]
rendering_mode*Rendering Mode
scope?Scope
Default"platform"
security_status?Security Status
Default"clean"
slug*Slug
source_type?Source Type
Default"builtin"
status?Status
Default"active"
tenant_id?|null
vertical*Vertical
visibility?Visibility
Default"customer"
Example Request
curl -X GET 'https://example.com/v1/templates/string'
Example Response
{  "custom_upload_id": "32c143b7-3420-4cb9-8ea3-6d8d9a659ee2",  "default_content": {},  "default_integrations": [],  "default_seo_description": "string",  "default_seo_title": "string",  "default_skills": [],  "description": "string",  "display_order": 0,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "preview_image_url": "string",  "preview_urls": [],  "rendering_mode": "string",  "scope": "platform",  "security_status": "clean",  "slug": "string",  "source_type": "builtin",  "status": "active",  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",  "vertical": "string",  "visibility": "customer"}

Get Template Preview

GET
/v1/templates/{slug}/preview

Path Parameters

slug*Slug

Response Body

Successful Response

application/json
  1. response
generated?Generated
Defaulttrue
id*Id
Formatuuid
name*Name
preview_html*Preview Html
preview_image_url?string|null
preview_urls?array<string>
Default[]
slug*Slug
Example Request
curl -X GET 'https://example.com/v1/templates/string/preview'
Example Response
{  "generated": true,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "preview_html": "string",  "preview_image_url": "string",  "preview_urls": [],  "slug": "string"}

Telemetry

Previous Page

Tenant

Next Page