Show/hide List Operations Expand Operations

Domain

/api/{version}/projects/{project}/domains

GET /api/{version}/projects/{project}/domains

Get domains

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project

Filters

Name

Information

page

Requirement	[0-9]+
Description	Page for list pagination
Default	1

count

Requirement	[0-9]+
Description	Number of items by page
Default	100

orderBy

Requirement	ASC\|DESC[]
Description	Order by array (key is field, value is direction)

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	>=1.0
type	string	>=1.0
status	string	>=1.0
name	string	>=1.0
project	integer	>=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/{version}/projects/{project}/domains

Create domain

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project		Project

Parameters

Parameter	Type	Required?	Format	Description
name	string	true

Return

Parameter	Type	Versions
200
id	integer	>=1.0
type	string	>=1.0
status	string	>=1.0
name	string	>=1.0
project	integer	>=1.0

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/{version}/projects/{project}/domains/{domain}

Delete domain by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project
domain

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/{version}/projects/{project}/domains/{domain}

Update domain by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project
domain

Parameters

Parameter	Type	Required?	Format	Description
name	string	true

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	>=1.0
type	string	>=1.0
status	string	>=1.0
name	string	>=1.0
project	integer	>=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/{version}/projects/{project}/domains/{domain}/dns

Get domain DNS by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project		Project
domain

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Media

/api/{version}/projects/{project}/media

DELETE /api/{version}/projects/{project}/media

Delete media

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project

Parameters

Parameter	Type	Required?	Format	Description
id_list	string	true		List of ids separated by commas (ex. 1,20,100)

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/{version}/projects/{project}/media

Get media list

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project

Filters

Name

Information

page

Requirement	[0-9]+
Description	Page for list pagination
Default	1

count

Requirement	^[1-9][0-9]?$\|^1[0-9][0-9]$\|^(200)$
Description	Number of items by page
Default	100

orderBy

Requirement	ASC\|DESC[]
Description	Order by array (key is field, value is direction)

name

Requirement	.+
Description	Unique media name

filename

Requirement	.+
Description	Canonical media name

type

Requirement	(image\|video\|audio\|document)
Description	Media type

Return

Parameter	Type	Versions
200 - Returned when successful
type	string	>=1.0
id	integer	>=1.0
uid	string	>=1.0
name	string	>=1.0
filename	string	>=1.0
project	integer	>=1.0
metadata	string	>=1.0
alt_title	string	>=1.0
mime	string	>=1.0
size	integer	>=1.0
url	string	>=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/{version}/projects/{project}/media

Create media

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project

Parameters

Parameter	Type	Required?	Format	Description
type	choice	false	[["image","audio","video","document"]]	Media type
filename	string	false		Canonical name
name	string	true		Unique name
alt_title	string	false		Alt Title
attachment	string	true		Base64 file string

Return

Parameter	Type	Versions
200
type	string	>=1.0
id	integer	>=1.0
uid	string	>=1.0
name	string	>=1.0
filename	string	>=1.0
project	integer	>=1.0
metadata	string	>=1.0
alt_title	string	>=1.0
mime	string	>=1.0
size	integer	>=1.0
url	string	>=1.0

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/{version}/projects/{project}/media/{media}

Get media by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project
media

Return

Parameter	Type	Versions
200 - Returned when successful
type	string	>=1.0
id	integer	>=1.0
uid	string	>=1.0
name	string	>=1.0
filename	string	>=1.0
project	integer	>=1.0
metadata	string	>=1.0
alt_title	string	>=1.0
mime	string	>=1.0
size	integer	>=1.0
url	string	>=1.0
author	string	>=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/{version}/projects/{project}/media/{media}

Update media

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project
media

Parameters

Parameter	Type	Required?	Format	Description
filename	string	false		Canonical name
alt_title	string	false		Alt Title

Return

Parameter	Type	Versions
200
type	string	>=1.0
id	integer	>=1.0
uid	string	>=1.0
name	string	>=1.0
filename	string	>=1.0
project	integer	>=1.0
metadata	string	>=1.0
alt_title	string	>=1.0
mime	string	>=1.0
size	integer	>=1.0
url	string	>=1.0

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Page

/api/{version}/projects/{project}/pages

GET /api/{version}/projects/{project}/pages

Get pages

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project

Filters

Name

Information

page

Requirement	[0-9]+
Description	Page for list pagination
Default	1

count

Requirement	[0-9]+
Description	Number of items by page
Default	100

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/{version}/projects/{project}/pages

Create a page

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project

Parameters

Parameter	Type	Required?	Format
title	string	true
slug	string	true
description	string	false
seo	object (PageSeoCreateType)	true
seo[title]	string	false
seo[description]	string	false
seo[enable_indexing]	choice	true	[false,true]
social	object (PageSocialCreateType)	true
social[title]	string	false
social[description]	string	false
social[image]	file	false
code_injection	object (PageCodeCreateType)	true
code_injection[css]	string	false
code_injection[js]	object (PageCodeJsCreateType)	false
code_injection[js][header]	string	false
code_injection[js][footer]	string	false
page_data	string	false

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/{version}/projects/{project}/pages/{page}/html

Get page html by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project		Project
page

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/{version}/projects/{project}/pages/{page}/updates

Update a page

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project
page

Parameters

Parameter	Type	Required?	Format
title	string	false
slug	string	false
description	string	false
seo	object (PageSeoCreateType)	true
seo[title]	string	false
seo[description]	string	false
seo[enable_indexing]	choice	true	[false,true]
social	object (PageSocialCreateType)	true
social[title]	string	false
social[description]	string	false
social[image]	file	false
code_injection	object (PageCodeCreateType)	true
code_injection[css]	string	false
code_injection[js]	object (PageCodeJsCreateType)	false
code_injection[js][header]	string	false
code_injection[js][footer]	string	false
page_data	string	false

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Post

/api/{version}/projects

POST /api/{version}/projects/{project}/posts

Create a post

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project

Parameters

Parameter	Type	Required?	Format
title	string	true
slug	string	true
excerpt	string	false
image	file	false
seo	object (PageSeoCreateType)	true
seo[title]	string	false
seo[description]	string	false
seo[enable_indexing]	choice	true	[false,true]
social	object (PageSocialCreateType)	true
social[title]	string	false
social[description]	string	false
social[image]	file	false
code_injection	object (PageCodeCreateType)	true
code_injection[css]	string	false
code_injection[js]	object (PageCodeJsCreateType)	false
code_injection[js][header]	string	false
code_injection[js][footer]	string	false
page_data	string	false

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Project

/api/{version}/projects

GET /api/{version}/projects

Get projects

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
workspace	[0-9]+		Workspace id

Filters

Name

Information

page

Requirement	[0-9]+
Description	Page for list pagination
Default	1

count

Requirement	^[1-9][0-9]?$\|^1[0-9][0-9]$\|^(200)$
Description	Number of items by page
Default	100

orderBy

Requirement	ASC\|DESC[]
Description	Order by array (key is field, value is direction)

Return

Parameter	Type	Versions	Description
200 - Returned when successful
workspace	integer	>=2.0
deployment_status	string	>=2.0	in_progress\|deployed
status	string	>=2.0	active\|suspended
translation_version	integer	<=1.0
id	integer	>=1.0
container	integer	<=1.0
name	string	>=1.0
data	string	<=1.0
site_id	integer	<=1.0
uid	string	>=1.0
site_title	string	<=1.0
site_description	string	<=1.0
code_injection_footer	string	<=1.0
code_injection_header	string	<=1.0
social_status_message	string	<=1.0
social_description	string	<=1.0
custom_css	string	<=1.0
is_using_sync	string	<=1.0
redirects	string	*
index_item_id	string	<=1.0
is_pro	boolean	<=1.0
canonical_domain	string	<=1.0
metadata	string	>=2.0
system_code_injection_footer	string	>=2.0
system_code_injection_header	string	>=2.0
dataVersion	integer	<=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/{version}/projects

Create project

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version

Parameters

Parameter	Type	Required?
uid	string	false
name	string	false
workspace	string	true

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/{version}/projects/{project}

Delete project

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project		Project

Filters

Name

Information

permanent

Requirement	true
Description	Permanently delete

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/{version}/projects/{project}

Get project by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project

Return

Parameter	Type	Versions	Description
200 - Returned when successful
workspace	integer	>=2.0
deployment_status	string	>=2.0	in_progress\|deployed
status	string	>=2.0	active\|suspended
translation_version	integer	<=1.0
id	integer	>=1.0
container	integer	<=1.0
name	string	>=1.0
data	string	<=1.0
site_id	integer	<=1.0
uid	string	>=1.0
site_title	string	<=1.0
site_description	string	<=1.0
code_injection_footer	string	<=1.0
code_injection_header	string	<=1.0
social_status_message	string	<=1.0
social_description	string	<=1.0
custom_css	string	<=1.0
is_using_sync	string	<=1.0
redirects	string	*
index_item_id	string	<=1.0
is_pro	boolean	<=1.0
canonical_domain	string	<=1.0
metadata	string	>=2.0
system_code_injection_footer	string	>=2.0
system_code_injection_header	string	>=2.0
dataVersion	integer	<=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/{version}/projects/{project}

Update project

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project		Project

Parameters

Parameter	Type	Required?	Format
name	string	false
status	choice	false	[[["active","suspended"]]]
metadata	string	false
system_code_injection_header	string	false
system_code_injection_footer	string	false
redirects	string	false

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/{version}/projects/{project}/duplicates

Duplicate project

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project		int

Parameters

Parameter	Type	Required?	Format	Description
uid	string	false
workspace	string	true		Target Workspace

Return

Parameter	Type	Versions	Description
200
workspace	integer	>=2.0
deployment_status	string	>=2.0	in_progress\|deployed
id	integer	>=1.0
name	string	>=1.0
uid	string	>=1.0

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/{version}/projects/{project}/html/download

Download project HTML as ZIP

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project		Project

Return

Parameter	Type	Versions
200 - Returned when successful
message	string	>=2.0
next_url	string	>=2.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/{version}/projects/{project}/html/export

Initiates project HTML export

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project		Project

Return

Parameter	Type	Versions
200 - Returned when successful
message	string	>=2.0
next_url	string	>=2.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/{version}/projects/{project}/leads

Get project leads

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project		Project

Filters

Name

Information

page

Requirement	[1-9][0-9]*
Description	Page for list pagination
Default	1

count

Requirement	^[1-9][0-9]?$\|^1[0-9][0-9]$\|^(200)$
Description	Number of items by page
Default	100

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	>=1.0
created_at	string	>=1.0
form_data	array	>=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/{version}/projects/{project}/leads/export

Export project leads in CSV or XLS format

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project		Project

Filters

Name

Information

file_type

Requirement	csv\|xls
Description	File type
Default	csv

Return

Parameter	Type	Versions	Description
200 - Returned when successful
download_url	string	>=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/{version}/projects/{project}/restore

Restore project

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/{version}/projects/{project}/sync/download

Download the Server Sync ZIP file

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project		Project

Return

Parameter	Type	Versions	Description
200 - Returned when successful
download_url	string	>=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Team Member

/api/{version}/team_members

GET /api/{version}/team_members

Get team member list

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version

Filters

Name

Information

workspace

Requirement	[0-9]+
Description	Workspace id

user

Requirement	[0-9]+
Description	User id

page

Requirement	[0-9]+
Description	Page for list pagination
Default	1

count

Requirement	^[1-9][0-9]?$\|^1[0-9][0-9]$\|^(200)$
Description	Number of items by page
Default	100

orderBy

Requirement	ASC\|DESC[]
Description	Order by array (key is field, value is direction)

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	>=1.0
workspace	integer	>=1.0
user	integer	>=1.0
role	string	>=1.0
status	string	>=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/{version}/team_members

Create a team member

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version

Parameters

Parameter	Type	Required?	Format
user	string	true
workspace	string	true
role	choice	true	[["editor","viewer","manager","designer"]]

Return

Parameter	Type	Versions
200
id	integer	>=1.0
workspace	integer	>=1.0
user	integer	>=1.0
role	string	>=1.0
status	string	>=1.0

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/{version}/team_members/{team_member}

Delete a team member by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
team_member

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/{version}/team_members/{team_member}

Update a team member by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
team_member

Parameters

Parameter	Type	Required?	Format	Description
status	choice	false	[["pending","approved"]]
role	choice	false	[["editor","viewer","manager","designer"]]

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	>=1.0
workspace	integer	>=1.0
user	integer	>=1.0
role	string	>=1.0
status	string	>=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Template

GET /api/{version}/template_categories

Get template category list

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/{version}/templates

Get template list

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version

Filters

Name

Information

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

User

GET /api/{version}/users

Get users

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version

Filters

Name

Information

page

Requirement	[0-9]+
Description	Page for list pagination
Default	1

count

Requirement	^[1-9][0-9]?$\|^1[0-9][0-9]$\|^(200)$
Description	Number of items by page
Default	50

email

Requirement	.+
Description	User email

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	>=1.0
email	string	>=1.0
name_l	string	>=1.0
name_f	string	>=1.0
products	array	>=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/{version}/users

Create user

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		Email
status	choice	true	[["verified"]]	Depending on the status, the user's email address may be validated upon creation

Return

Parameter	Type	Versions
200
id	integer	>=1.0
email	string	>=1.0
name_l	string	>=1.0
name_f	string	>=1.0
products	array	>=1.0
token	string	>=1.0

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/{version}/users/{id}

Delete user by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
id

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/{version}/users/{id}

Get user by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
id

Return

Parameter	Type	Versions
200
id	integer	>=1.0
email	string	>=1.0
name_l	string	>=1.0
name_f	string	>=1.0
products	array	>=1.0
token	string	>=1.0

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/{version}/users/{id}

Update user by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
id

Parameters

Parameter	Type	Required?	Format	Description
email	string	false		Email
name_f	string	false		First Name
name_l	string	false		Last Name
pro_package	choice	false	["add","remove"]

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	>=1.0
email	string	>=1.0
name_l	string	>=1.0
name_f	string	>=1.0
products	array	>=1.0
token	string	>=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Webhook

/api/{version}/projects/{project}/webhooks

GET /api/{version}/projects/{project}/webhooks

Get webhooks

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project		Project

Return

Parameter	Type	Versions
200 - Returned when successful
id	string	>=2.0
url	string	>=2.0
enabled	string	>=2.0
asset	string	>=2.0
action	string	>=2.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/{version}/projects/{project}/webhooks

Create a webhook

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project

Parameters

Parameter	Type	Required?	Format
url	string	true
enabled	choice	true	[0,1]
asset	string	true
action	choice	true	["create","update","delete"]

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/{version}/projects/{project}/webhooks/{webhook}

Delete webhook

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project		Project
webhook

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/{version}/projects/{project}/webhooks/{webhook}

Update a webhook

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
project
webhook

Parameters

Parameter	Type	Required?	Format
url	string	false
enabled	choice	false	[0,1]
asset	string	false
action	choice	false	["create","update","delete"]

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Workspace

/api/{version}/workspaces

GET /api/{version}/workspaces

Get workspaces

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version

Filters

Name

Information

page

Requirement	[0-9]+
Description	Page for list pagination
Default	1

count

Requirement	^[1-9][0-9]?$\|^1[0-9][0-9]$\|^(200)$
Description	Number of items by page
Default	100

orderBy

Requirement	ASC\|DESC[]
Description	Order by array (key is field, value is direction)

name

Requirement	.+
Description	Workspace name

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	>=1.0
name	string	>=1.0
project_count	integer	>=1.0
role	object (Role)	>=1.0
role[slug]	string	>=1.0
role[name]	string	>=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/{version}/workspaces

Create a workspace

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version

Parameters

Parameter	Type	Required?	Format	Description
name	string	true

Return

Parameter	Type	Versions
200
id	integer	>=1.0
name	string	>=1.0
project_count	integer	>=1.0
role	object (Role)	>=1.0
role[slug]	string	>=1.0
role[name]	string	>=1.0

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/{version}/workspaces/count

Get workspaces count

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version

Filters

Name

Information

role

Requirement	admin\|editor\|manager\|designer\|viewer
Description	Role

Return

Parameter	Type	Versions	Description
200 - Returned when successful
count	integer	>=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/{version}/workspaces/{workspace}

Delete a workspace by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
workspace

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/{version}/workspaces/{workspace}

Update a workspace by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
version	^(\d+\.\d+)$	string	API Version
workspace

Parameters

Parameter	Type	Required?	Format	Description
name	string	true

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	>=1.0
name	string	>=1.0
project_count	integer	>=1.0
role	object (Role)	>=1.0
role[slug]	string	>=1.0
role[name]	string	>=1.0

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when request syntax is incorrect
404	Returned when the page is not found
429	Returned when the client sent too many requests during a time period
500	Returned when an internal server error occured

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

API documentation

Domain

/api/{version}/projects/{project}/domains

GET /api/{version}/projects/{project}/domains

Requirements

Filters

Return

200 - Returned when successful

Status Codes

Requirements

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/{version}/projects/{project}/domains

Requirements

Parameters

Return

200

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/{version}/projects/{project}/domains/{domain}

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/{version}/projects/{project}/domains/{domain}

Requirements

Parameters

Return

200 - Returned when successful

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/{version}/projects/{project}/domains/{domain}/dns

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Media

/api/{version}/projects/{project}/media

DELETE /api/{version}/projects/{project}/media

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/{version}/projects/{project}/media

Requirements

Filters

Return

200 - Returned when successful

Status Codes

Requirements