fn get_projects(page?: number, per_page?: number)
Get projects
| Argument | Type | Required | Description |
|---|
| page? | number | no | |
| per_page? | number | no | |
fn create_project(build_config?: object, deployment_configs?: object, name: string, production_branch: string, source?: object)
Create project
| Argument | Type | Required | Description |
|---|
| build_config? | object | no | Configs for the project build process. |
| deployment_configs? | object | no | Configs for deployments in a project. |
| name | string | yes | Name of the project. |
| production_branch | string | yes | Production branch of the project. Used to identify production deployments. |
| source? | object | no | Configs for the project source control. |
fn get_project(project_name: string)
Get project
| Argument | Type | Required | Description |
|---|
| project_name | string | yes | |
fn update_project(project_name: string, build_config?: object, deployment_configs?: object, name?: string, production_branch?: string, source?: object)
Update project
| Argument | Type | Required | Description |
|---|
| project_name | string | yes | |
| build_config? | object | no | Configs for the project build process. |
| deployment_configs? | object | no | Configs for deployments in a project. |
| name? | string | no | Name of the project. |
| production_branch? | string | no | Production branch of the project. Used to identify production deployments. |
| source? | object | no | Configs for the project source control. |
fn delete_project(project_name: string)
Delete project
| Argument | Type | Required | Description |
|---|
| project_name | string | yes | |
fn get_deployments(project_name: string, env?: enum, page?: number, per_page?: number)
Get deployments
| Argument | Type | Required | Description |
|---|
| project_name | string | yes | |
| env? | enum | no | |
| page? | number | no | |
| per_page? | number | no | |
fn create_deployment(project_name: string)
Create deployment
| Argument | Type | Required | Description |
|---|
| project_name | string | yes | |
fn get_deployment_info(deployment_id: string, project_name: string)
Get deployment info
| Argument | Type | Required | Description |
|---|
| deployment_id | string | yes | |
| project_name | string | yes | |
fn delete_deployment(deployment_id: string, project_name: string, force?: boolean)
Delete deployment
| Argument | Type | Required | Description |
|---|
| deployment_id | string | yes | |
| project_name | string | yes | |
| force? | boolean | no | |
fn get_deployment_logs(deployment_id: string, project_name: string)
Get deployment logs
| Argument | Type | Required | Description |
|---|
| deployment_id | string | yes | |
| project_name | string | yes | |
fn pages_deployment_retry_deployment(deployment_id: string, project_name: string)
Retry deployment
| Argument | Type | Required | Description |
|---|
| deployment_id | string | yes | |
| project_name | string | yes | |
fn pages_deployment_rollback_deployment(deployment_id: string, project_name: string)
Rollback deployment
| Argument | Type | Required | Description |
|---|
| deployment_id | string | yes | |
| project_name | string | yes | |
fn create_tail(deployment_id: string, project_name: string, filters?: array)
Create deployment tail
| Argument | Type | Required | Description |
|---|
| deployment_id | string | yes | |
| project_name | string | yes | |
| filters? | array | no | Filters to apply to the tail session. |
fn delete_tail(tail_id: string, deployment_id: string, project_name: string)
Delete deployment tail
| Argument | Type | Required | Description |
|---|
| tail_id | string | yes | |
| deployment_id | string | yes | |
| project_name | string | yes | |
fn get_domains(project_name: string)
Get domains
| Argument | Type | Required | Description |
|---|
| project_name | string | yes | |
fn create_pages_domains_add_domain(project_name: string, name: unknown)
Add domain
| Argument | Type | Required | Description |
|---|
| project_name | string | yes | |
| name | unknown | yes | |
fn get_domain(domain_name: string, project_name: string)
Get domain
| Argument | Type | Required | Description |
|---|
| domain_name | string | yes | |
| project_name | string | yes | |
fn patch_domain(domain_name: string, project_name: string)
Patch domain
| Argument | Type | Required | Description |
|---|
| domain_name | string | yes | |
| project_name | string | yes | |
fn delete_domain(domain_name: string, project_name: string)
Delete domain
| Argument | Type | Required | Description |
|---|
| domain_name | string | yes | |
| project_name | string | yes | |
fn pages_purge_build_cache(project_name: string)
Purge build cache
| Argument | Type | Required | Description |
|---|
| project_name | string | yes | |
fn create_pages_project_connect_project_source(project_name: string, config: object, type: enum)
Connect project source
| Argument | Type | Required | Description |
|---|
| project_name | string | yes | |
| config | object | yes | |
| type | enum | yes | The source control management provider. |
fn delete_pages_project_disconnect_project_source(project_name: string)
Disconnect project source
| Argument | Type | Required | Description |
|---|
| project_name | string | yes | |
fn get_upload_token(project_name: string)
Get upload token
| Argument | Type | Required | Description |
|---|
| project_name | string | yes | |
Resources
get_projects(infinite)— Get projects
project(infinite)— Create project
get_deployments(infinite)— Get deployments
deployment(infinite)— Create deployment
deployment_info(infinite)— Get deployment info
deployment_logs(infinite)— Get deployment logs
pages_deployment_retry_deployment(infinite)— Retry deployment
pages_deployment_rollback_deployment(infinite)— Rollback deployment
tail(infinite)— Create deployment tail
get_domains(infinite)— Get domains
pages_domains_add_domain(infinite)— Add domain
domain(infinite)— Get domain
patch_domain(infinite)— Patch domain
pages_purge_build_cache(infinite)— Purge build cache
pages_project_connect_project_source(infinite)— Connect project source
upload_token(infinite)— Get upload token