Listar sites
Um site é o host onde uma página é publicada. Esta API não exclui sites.
Escopo exigido: sites:read.
query Parameters
limitQuantidade máxima de registros. O padrão é 50 e o máximo é 100.
pageÍndice de página começando em zero. A API devolve limit registros a partir de page × limit.
project_idApenas registros deste projeto.
queryTexto sem distinção de maiúsculas comparado com o nome e os campos relacionados.
Listar sites › Responses
Registros correspondentes. O corpo é um array JSON.
idId do site.
nameNome de exibição, muitas vezes o domínio.
site_nameNome salvo no site.
domainDomínio público.
custom_domainDomínio próprio, quando conectado.
atomic_domainDomínio fornecido pela Atomicat.
project_idId do projeto.
statusStatus do site quando existir.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
Criar um site
Cria um site e devolve o domínio Atomicat. Inclui instruções de DNS do domínio próprio quando existirem.
Escopo exigido: sites:write.
Criar um site › Request Body
nameNome do site.
descriptionDescrição.
project_idProjeto ao qual o site será ligado.
Criar um site › Responses
O site criado.
idId do site.
site_idO mesmo valor de id.
nameNome do site.
atomic_domainDomínio Atomicat.
urlURL pública.
project_idId do projeto.
custom_domain_instructionsInstruções de DNS do domínio próprio, quando devolvidas.
Buscar sites
Escopo exigido: sites:read.
query Parameters
limitQuantidade máxima de registros. O padrão é 50 e o máximo é 100.
queryTexto sem distinção de maiúsculas comparado com o nome e os campos relacionados.
project_idApenas registros deste projeto.
site_idId exato. Devolve um array com um item.
Buscar sites › Responses
Registros correspondentes. O corpo é um array JSON.
idId do site.
nameNome de exibição, muitas vezes o domínio.
site_nameNome salvo no site.
domainDomínio público.
custom_domainDomínio próprio, quando conectado.
atomic_domainDomínio fornecido pela Atomicat.
project_idId do projeto.
statusStatus do site quando existir.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
Obter um site
Escopo exigido: sites:read.
path Parameters
siteIdId do site.
Obter um site › Responses
O site.
idId do site.
nameNome de exibição, muitas vezes o domínio.
site_nameNome salvo no site.
domainDomínio público.
custom_domainDomínio próprio, quando conectado.
atomic_domainDomínio fornecido pela Atomicat.
project_idId do projeto.
statusStatus do site quando existir.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.