api.md

Pages

Projects

Types:

• Deployment
• Project
• Stage
• ProjectDeleteResponse
• ProjectPurgeBuildCacheResponse

Methods:

• client.pages.projects.create({ ...params }) -> Project
• client.pages.projects.list({ ...params }) -> ProjectsV4PagePaginationArray
• client.pages.projects.delete(projectName, { ...params }) -> ProjectDeleteResponse | null
• client.pages.projects.edit(projectName, { ...params }) -> Project
• client.pages.projects.get(projectName, { ...params }) -> Project
• client.pages.projects.purgeBuildCache(projectName, { ...params }) -> ProjectPurgeBuildCacheResponse | null

Deployments

Types:

• DeploymentDeleteResponse

Methods:

• client.pages.projects.deployments.create(projectName, { ...params }) -> Deployment
• client.pages.projects.deployments.list(projectName, { ...params }) -> DeploymentsV4PagePaginationArray
• client.pages.projects.deployments.delete(projectName, deploymentId, { ...params }) -> DeploymentDeleteResponse | null
• client.pages.projects.deployments.get(projectName, deploymentId, { ...params }) -> Deployment
• client.pages.projects.deployments.retry(projectName, deploymentId, { ...params }) -> Deployment
• client.pages.projects.deployments.rollback(projectName, deploymentId, { ...params }) -> Deployment

History

Logs

Types:

• LogGetResponse

Methods:

• client.pages.projects.deployments.history.logs.get(projectName, deploymentId, { ...params }) -> LogGetResponse

Domains

Types:

• DomainCreateResponse
• DomainListResponse
• DomainDeleteResponse
• DomainEditResponse
• DomainGetResponse

Methods:

• client.pages.projects.domains.create(projectName, { ...params }) -> DomainCreateResponse
• client.pages.projects.domains.list(projectName, { ...params }) -> DomainListResponsesSinglePage
• client.pages.projects.domains.delete(projectName, domainName, { ...params }) -> DomainDeleteResponse | null
• client.pages.projects.domains.edit(projectName, domainName, { ...params }) -> DomainEditResponse
• client.pages.projects.domains.get(projectName, domainName, { ...params }) -> DomainGetResponse