api.md

Shared

Types:

• Analytics
• Deployment
• Domain
• KvDatabase
• Project

Organizations

Types:

• Organization

Methods:

• client.organizations.get(organizationId) -> Organization

Analytics

Methods:

• client.organizations.analytics.get(organizationId, { ...params }) -> Analytics

Projects

Types:

• ProjectListResponse

Methods:

• client.organizations.projects.create(organizationId, { ...params }) -> Project
• client.organizations.projects.list(organizationId, { ...params }) -> ProjectListResponse

Databases

Types:

• DatabaseListResponse

Methods:

• client.organizations.databases.create(organizationId, { ...params }) -> KvDatabase
• client.organizations.databases.list(organizationId, { ...params }) -> DatabaseListResponse

Domains

Types:

• DomainListResponse

Methods:

• client.organizations.domains.create(organizationId, { ...params }) -> Domain
• client.organizations.domains.list(organizationId, { ...params }) -> DomainListResponse

Databases

Methods:

• client.databases.update(databaseId, { ...params }) -> KvDatabase

Projects

Methods:

• client.projects.update(projectId, { ...params }) -> Project
• client.projects.delete(projectId) -> void
• client.projects.get(projectId) -> Project

Analytics

Methods:

• client.projects.analytics.get(projectId, { ...params }) -> Analytics

Deployments

Types:

• DeploymentListResponse

Methods:

• client.projects.deployments.create(projectId, { ...params }) -> Deployment
• client.projects.deployments.list(projectId, { ...params }) -> DeploymentListResponse

Deployments

Methods:

• client.deployments.delete(deploymentId) -> void
• client.deployments.get(deploymentId) -> Deployment
• client.deployments.redeploy(deploymentId, { ...params }) -> Deployment

BuildLogs

Types:

• BuildLogGetResponse

Methods:

• client.deployments.buildLogs.get(deploymentId) -> BuildLogGetResponse

AppLogs

Types:

• AppLogGetResponse

Methods:

• client.deployments.appLogs.get(deploymentId, { ...params }) -> AppLogGetResponse

Domains

Methods:

• client.domains.update(domainId, { ...params }) -> void
• client.domains.delete(domainId) -> void
• client.domains.get(domainId) -> Domain
• client.domains.verify(domainId) -> void

Certificates

Methods:

• client.domains.certificates.create(domainId, { ...params }) -> void
• client.domains.certificates.provision(domainId) -> void