List sites
A site is the host a page is published to. This API does not delete sites.
Required scope: sites:read.
query Parameters
limitMaximum number of records. Defaults to 50 and cannot exceed 100.
pageZero-based page index. The API returns limit records starting at page × limit.
project_idOnly records in this project.
queryCase-insensitive text matched against the record name and related fields.
List sites › Responses
Matching records. The body is a JSON array.
idSite id.
nameDisplay name, often the domain.
site_nameName stored on the site.
domainPublic domain.
custom_domainCustom domain, when connected.
atomic_domainAtomicat-provided domain.
project_idProject id.
statusSite status when present.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
Create a site
Creates a hosting site and returns its Atomicat domain. Custom domain DNS instructions are included when available.
Required scope: sites:write.
Create a site › Request Body
nameSite name.
descriptionSite description.
project_idProject to attach the site to.
Create a site › Responses
The created site.
idSite id.
site_idSame value as id.
nameSite name.
atomic_domainAtomicat domain.
urlPublic URL.
project_idProject id.
custom_domain_instructionsDNS instructions for a custom domain, when returned.
Search sites
Required scope: sites:read.
query Parameters
limitMaximum number of records. Defaults to 50 and cannot exceed 100.
queryCase-insensitive text matched against the record name and related fields.
project_idOnly records in this project.
site_idExact site id. Returns a one-item array.
Search sites › Responses
Matching records. The body is a JSON array.
idSite id.
nameDisplay name, often the domain.
site_nameName stored on the site.
domainPublic domain.
custom_domainCustom domain, when connected.
atomic_domainAtomicat-provided domain.
project_idProject id.
statusSite status when present.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
Get a site
Required scope: sites:read.
path Parameters
siteIdSite id.
Get a site › Responses
The site.
idSite id.
nameDisplay name, often the domain.
site_nameName stored on the site.
domainPublic domain.
custom_domainCustom domain, when connected.
atomic_domainAtomicat-provided domain.
project_idProject id.
statusSite status when present.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.