Cloudflare Pages: list projects and deployments, trigger a build of a Git-connected project, retry, and roll back. Direct Upload deploys (sending built files) are out of scope — use wrangler pages deploy.

Context Vars

Optional
  • cloudflare.token
  • cloudflare.account.id

Functions

create-deployment

fn (project: Str): Map
fn (project: Str, options: Map): Map
fn (project: Str, options: Map, opts: Map): Map

POST .../pages/projects/{name}/deployments - Start a new build of a Git-connected project: the production branch by default, or options.branch (a preview branch). Returns the new deployment.

Example

deployment ::cloudflare::pages/create-deployment("marketing-site", {branch: "main"})
deployment.id

deployment-parts

fn (options: Map): Vec

The multipart fields for a Git build trigger: branch and the optional commit fields, omitted when unset. Exposed for testing.

deployment-suffix

fn (project: Str, deployment-id: Str): Str

get-deployment

fn (project: Str, deployment-id: Str): Map
fn (project: Str, deployment-id: Str, opts: Map): Map

GET .../deployments/{id} - One deployment: url, environment, latest_stage ({name, status}), deployment_trigger.

get-project

fn (project: Str): Map
fn (project: Str, opts: Map): Map

GET .../pages/projects/{name} - A project: subdomain, domains, source, build config, latest deployment.

list-all-projects

fn (): Vec
fn (max: Int): Vec
fn (opts: Map): Vec
fn (max: Int, opts: Map): Vec

Every Pages project, following pages up to max (default 10000).

list-deployments

fn (project: Str): ::cloudflare::api/ListPage
fn (project: Str, params: Map): ::cloudflare::api/ListPage
fn (project: Str, params: Map, opts: Map): ::cloudflare::api/ListPage

GET .../pages/projects/{name}/deployments - One page of a project's deployments, newest first. params: env (production or preview), page, per_page. Returns a ListPage.

list-projects

fn (): ::cloudflare::api/ListPage
fn (params: Map): ::cloudflare::api/ListPage
fn (params: Map, opts: Map): ::cloudflare::api/ListPage

GET /accounts/{account_id}/pages/projects - One page of projects (page, per_page). Returns a ListPage.

project-suffix

fn (project: Str): Str

retry-deployment

fn (project: Str, deployment-id: Str): Map
fn (project: Str, deployment-id: Str, opts: Map): Map

POST .../deployments/{id}/retry - Re-run a deployment's build.

rollback-deployment

fn (project: Str, deployment-id: Str): Map
fn (project: Str, deployment-id: Str, opts: Map): Map

POST .../deployments/{id}/rollback - Make an earlier successful production deployment live again.