Overview

Public developer API. Authenticate with an API token sent as Authorization: Bearer <token>. Issue tokens from the agiler dashboard at https://app.agiler.io.

Version: v1
Base URL: https://api.agiler.io/v1
Content type: application/json on all requests and responses unless noted on a specific endpoint.
OpenAPI spec: /openapi.json — download to generate an SDK (openapi-generator, Speakeasy, Fern) or import into Postman / Insomnia.

Authentication

apiKeyAuth · http (bearer)

API key issued by POST /auth/tokens, sent as Authorization: Bearer <token>. Scopes and resource access can be updated after creation and are enforced server-side.
curl -H "Authorization: Bearer $AGILER_TOKEN" \
     https://api.agiler.io/v1/projects

API-key scopes and resource access can be edited in the dashboard under Settings → API Keys and are enforced server-side. Each operation below lists the scopes it requires.

Errors

Errors return a non-2xx status and a JSON body shaped as an ErrorResponse:

{
  "error": {
    "code": "validation_error",
    "field": "name",
    "message": "name must not be empty"
  }
}

Common status codes used across the API:

StatusMeaning
400Malformed request body or parameters
401Missing or invalid bearer token
403The token or workspace role does not grant access to the resource
404Resource not found (or hidden from the caller)
409Conflict — e.g. idempotency key reused with a different body
429Rate limited; honor Retry-After
500Server error; safe to retry idempotent calls

Idempotency

Write requests (POST, PUT, PATCH, and DELETE) accept an Idempotency-Key header. Use a unique value, such as a UUID, for each operation and reuse it when retrying that operation. While a recorded response is available, a matching request with the same method, URL (including query parameters), and body replays that response. Reusing the key with a different method, URL, or body returns 409, as does a retry while the original request is still processing. Keys are scoped to the authenticated credential and its permissions; use the same credential and access settings for retries.

Endpoints

Grouped by feature area; use “On this page” to jump to a group.

Projects

get /projects

List your projects

Scopes: projects:read

Query parameters
  • workspace_id string · uuid — Filter projects to a workspace id.
  • cursor string — Cursor for the next page (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of results to return. Default: 50
Responses

post /projects

Create a project

Scopes: projects:write

Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Request body

application/json

CreateProjectInput

Responses

delete /projects/{project}

Delete a project

Scopes: projects:write

Path parameters
  • project string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Responses

get /projects/{project}

Get a project

Scopes: projects:read

Path parameters
  • project string required
Responses

patch /projects/{project}

Update a project

Scopes: projects:write

Path parameters
  • project string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Request body

application/json

UpdateProjectInput

Responses

Project Backups

get /projects/{project}/backups

List backups for a project

Scopes: projects.backups:read

Path parameters
  • project string required
Query parameters
  • cursor string — Cursor for the next page (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of results to return. Default: 50
Responses

post /projects/{project}/backups

Trigger an on-demand backup

Scopes: projects.backups:write

Path parameters
  • project string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Responses

get /projects/{project}/backups/policy

Get the project's backup policy

Scopes: projects.backups:read

Path parameters
  • project string required
Responses

patch /projects/{project}/backups/policy

Update the project's backup policy

Scopes: projects.backups:write

Path parameters
  • project string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Request body

application/json

UpdateProjectBackupPolicyInput

Responses

delete /projects/{project}/backups/{backup}

Delete a backup

Scopes: projects.backups:write

Path parameters
  • project string required
  • backup string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Responses

get /projects/{project}/backups/{backup}/database

Download the database dump for a backup

Scopes: projects.backups:read

Path parameters
  • project string required
  • backup string required
Responses

post /projects/{project}/backups/{backup}/restore

Restore a backup (asynchronous; returns 202)

Scopes: projects.backups:write

Path parameters
  • project string required
  • backup string required
Query parameters
  • drain_requests boolean — Wait for in-flight requests to drain before starting the restore. Defaults to false.
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Responses

get /projects/{project}/backups/{backup}/storage

Download the storage archive for a backup

Scopes: projects.backups:read

Path parameters
  • project string required
  • backup string required
Responses

Project Domains

get /projects/{project}/domains

List domains attached to a project

Scopes: projects.domains:read

Path parameters
  • project string required
Query parameters
  • cursor string — Cursor for the next page (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of results to return. Default: 50
Responses

post /projects/{project}/domains

Attach an exact or wildcard domain to a project

Scopes: projects.domains:write

Path parameters
  • project string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Request body

application/json

CreateProjectDomainInput

Responses

delete /projects/{project}/domains/{domain}

Detach a domain from a project

Scopes: projects.domains:write

Path parameters
  • project string required
  • domain string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Responses

patch /projects/{project}/domains/{domain}

Update a project domain (primary flag only today)

Scopes: projects.domains:write

Path parameters
  • project string required
  • domain string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Request body

application/json

UpdateProjectDomainInput

Responses

post /projects/{project}/domains/{domain}/recheck

Recheck DNS and certificate provisioning for a project domain

Scopes: projects.domains:write

Path parameters
  • project string required
  • domain string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Responses

Project Files

get /projects/{project}/files

List the root of a project's file tree

Scopes: projects.files:read

Path parameters
  • project string required
Query parameters
  • cursor string — Cursor for the next page (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of results to return. Default: 100
Responses

delete /projects/{project}/files/{path}

Delete a file or directory

Scopes: projects.files:write

Path parameters
  • project string required
  • path string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Responses

get /projects/{project}/files/{path}

List a directory or download a file (response shape depends on path)

Scopes: projects.files:read

Path parameters
  • project string required
  • path string required
Query parameters
  • cursor string — Cursor for the next page (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of results to return. Default: 100
Responses

put /projects/{project}/files/{path}

Upload a file, or move/copy via X-Move-Source / X-Copy-Source headers

Scopes: projects.files:write

Path parameters
  • project string required
  • path string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Request body

application/octet-stream

string

Responses

Project Logs

get /projects/{project}/logs

Fetch project request logs

Scopes: projects.logs:read

Path parameters
  • project string required
Query parameters
  • since string · date-time — RFC 3339 lower bound on the time window.
  • until string · date-time — RFC 3339 upper bound on the time window.
  • q string — Free-text filter on log lines.
  • cursor string — Cursor for the next page.
  • limit integer — Maximum number of results to return. Default: 100
Responses

Project Rules

get /projects/{project}/rules

List a project's rules

Scopes: projects.rules:read

Path parameters
  • project string required
Query parameters
  • cursor string — Cursor for the next page (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of results to return. Default: 50
Responses

post /projects/{project}/rules

Create a project rule

Scopes: projects.rules:write

Path parameters
  • project string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Request body

application/json

CreateProjectRuleInput

Responses

delete /projects/{project}/rules/{rule}

Delete a project rule

Scopes: projects.rules:write

Path parameters
  • project string required
  • rule string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Responses

get /projects/{project}/rules/{rule}

Fetch a single project rule

Scopes: projects.rules:read

Path parameters
  • project string required
  • rule string required
Responses

patch /projects/{project}/rules/{rule}

Update a project rule

Scopes: projects.rules:write

Path parameters
  • project string required
  • rule string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Request body

application/json

UpdateProjectRuleInput

Responses

Project SQL

get /projects/{project}/sql/statements

List recent SQL statement executions

Scopes: projects.sql:execute

Path parameters
  • project string required
Query parameters
  • cursor string — Cursor for the next page (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of results to return.
Responses

post /projects/{project}/sql/statements

Execute a SQL statement against the project database

Scopes: projects.sql:execute

Path parameters
  • project string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Request body

application/json

CreateSQLStatementInput

Responses

delete /projects/{project}/sql/statements/{statement}

Cancel or delete a SQL statement execution

Scopes: projects.sql:execute

Path parameters
  • project string required
  • statement string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Responses

get /projects/{project}/sql/statements/{statement}

Fetch a single SQL statement execution by id

Scopes: projects.sql:execute

Path parameters
  • project string required
  • statement string required
Query parameters
  • cursor string — Cursor for the next page of result rows (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of result rows to return (default 100, max 1000).
Responses

Project Usage

get /projects/{project}/usage

Fetch project usage time-series

Scopes: projects.usage:read

Path parameters
  • project string required
Query parameters
  • since string · date-time — RFC 3339 lower bound on the time window.
  • until string · date-time — RFC 3339 upper bound on the time window.
  • granularity string — Bucket size for the returned series. Defaults to day. One of: hour, day, week, month
  • cursor string — Cursor for the next page (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of buckets to return. Default: 30
Responses

Project Variables

get /projects/{project}/variables

List project environment variables

Scopes: projects.variables:read

Path parameters
  • project string required
Query parameters
  • cursor string — Cursor for the next page (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of results to return. Default: 100
Responses

post /projects/{project}/variables

Create a project variable

Scopes: projects.variables:write

Path parameters
  • project string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Request body

application/json

CreateProjectVariableInput

Responses

delete /projects/{project}/variables/{variable}

Delete a project variable

Scopes: projects.variables:write

Path parameters
  • project string required
  • variable string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Responses

patch /projects/{project}/variables/{variable}

Update a project variable

Scopes: projects.variables:write

Path parameters
  • project string required
  • variable string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Request body

application/json

UpdateProjectVariableInput

Responses

project-wp

get /projects/{project}/wp/commands

List recent wp-cli command executions

Scopes: projects.wp:execute

Path parameters
  • project string required
Query parameters
  • cursor string — Cursor for the next page (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of results to return.
Responses

post /projects/{project}/wp/commands

Execute a wp-cli command against the project

Scopes: projects.wp:execute

Path parameters
  • project string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Request body

application/json

CreateWPCommandInput

Responses

delete /projects/{project}/wp/commands/{command}

Cancel or delete a wp-cli command execution

Scopes: projects.wp:execute

Path parameters
  • project string required
  • command string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Responses

get /projects/{project}/wp/commands/{command}

Fetch a single wp-cli command execution by id

Scopes: projects.wp:execute

Path parameters
  • project string required
  • command string required
Query parameters
  • cursor string — Cursor for the next page of output lines (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of output lines to return (default 100, max 1000).
Responses

Regions

get /regions

List public regions

Scopes:

Query parameters
  • cursor string — Cursor for the next page (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of results to return. Default: 50
Responses

get /regions/{region}

Fetch a single region

Scopes:

Path parameters
  • region string required
Responses

Rules

get /rules

List the rule condition / action catalog

Scopes:

Responses

Runtimes

get /runtimes

List public runtimes

Scopes:

Query parameters
  • cursor string — Cursor for the next page (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of results to return. Default: 50
Responses

get /runtimes/{runtimeid}

Fetch a single runtime

Scopes:

Path parameters
  • runtimeid string required
Responses

Users

get /users/me

Fetch the authenticated user

Scopes:

Responses

Billing

get /users/me/billing

Get the caller's billing profile

Scopes: billing:read

Responses

patch /users/me/billing

Update billing budget and charge settings

Scopes: billing:write

Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Request body

application/json

UpdateBillingInput

Responses

get /users/me/billing/payment-methods

List the caller's billing payment methods

Scopes: billing:read

Responses

get /users/me/billing/statements/{period}

Download a monthly billing statement as PDF

Scopes: billing:read

Path parameters
  • period string required
Responses

get /users/me/billing/transactions

List billing transactions, grouped by month

Scopes: billing:read

Query parameters
  • year integer — Filter to transactions in this four-digit year (UTC).
  • month integer — Filter to transactions in this calendar month (1-12, UTC). Requires year.
  • cursor string — Cursor for the next page (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of results to return. Default: 12
Responses

Notifications

get /users/me/notifications

List the caller's notifications

Scopes: notifications:read

Query parameters
  • cursor string — Cursor for the next page (opaque; obtained from the previous response's Link rel="next").
  • limit integer — Maximum number of results to return. Default: 50
Responses

delete /users/me/notifications/{notification}

Dismiss a notification

Scopes: notifications:write

Path parameters
  • notification string required
Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Responses

Verify

get /users/me/verify

List the caller's pending verifications

Scopes:

Responses

workspaces

get /workspaces

List your workspaces

Scopes: projects:read

Responses

post /workspaces

Create a workspace

Scopes: projects:write

Header parameters
  • Idempotency-Key string — Opaque client-supplied retry token (any string up to 128 chars; UUIDs work well). If the server has seen this key on a prior request with the same body, it replays the recorded response. A different body under the same key returns 409.
Request body

application/json

CreateWorkspaceInput

Responses

get /workspaces/{workspace}

Get a workspace

Scopes: projects:read

Path parameters
  • workspace string required
Responses

get /workspaces/{workspace}/billing-transfer

Get pending workspace billing transfer

Scopes: projects:read

Path parameters
  • workspace string required
Responses

get /workspaces/{workspace}/members

List workspace members and pending invites

Scopes: projects:read

Path parameters
  • workspace string required
Responses

Schemas

Object shapes referenced by the operations above.

BillingOutput

  • account_id string required
  • address_city string required
  • address_country string required
  • address_line1 string required
  • address_line2 string required
  • address_state string required
  • address_zip string required
  • brand string required
  • budget_alerts array of integer required
  • budget_stop boolean required
  • charge_amount integer required
  • charge_threshold integer required
  • exp_month integer required
  • exp_year integer required
  • force_update string · date-time
  • last4 string required
  • monthly_budget integer required
  • name string required
  • update boolean

BillingTransactionEntry

  • amount integer required
  • created_at string · date-time required
  • description string required
  • expires_at string · date-time

BillingTransactionMonth

  • balance integer required
  • created_at string · date-time required
  • month integer required
  • tx array of BillingTransactionEntry required
  • year integer required

BinaryStream

string · binary

CreateProjectDomainInput

  • name string required — Exact FQDN or wildcard in the single supported form *.<valid-fqdn>.
  • primary boolean — Promote an exact domain to the project site domain. Wildcard domains cannot be primary.

CreateProjectInput

  • name string required
  • region string required
  • runtime string required
  • workspace_id string · uuid e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f

CreateProjectRuleInput

  • actions array of RuleStatement required
  • active boolean
  • conditions object required
  • name string required
  • priority number

CreateProjectVariableInput

  • name string required
  • sensitive boolean
  • value string required

CreateSQLStatementInput

  • read_only boolean required
  • sql string required
  • timeout integer

CreateWPCommandInput

  • command string required
  • timeout integer

CreateWorkspaceInput

  • name string required

ErrorPayload

  • code string required
  • field string
  • id string
  • message string required
  • resource string

ErrorResponse

FreeformObject

object — Freeform JSON object proxied from the edge runtime; the shape is owned by that service and may evolve independently of this API.

NotificationOutput

  • created_at string · date-time required
  • description string required
  • id string required
  • name string required
  • priority string required
  • title string required
  • url string required

PaymentMethodAddressOutput

  • city string required
  • country string required
  • line1 string required
  • line2 string required
  • postal_code string required
  • state string required

PaymentMethodBillingDetailsOutput

PaymentMethodCardOutput

  • brand string required
  • exp_month integer required
  • exp_year integer required
  • last4 string required

PaymentMethodOutput

PendingVerification

  • channel string required
  • expires_at string · date-time
  • target string required

ProjectBackupEntry

  • automatic boolean required
  • created_at string · date-time required
  • database_size integer
  • id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f
  • runtime string
  • size integer
  • status string required
  • storage_size integer

ProjectBackupPolicyOutput

  • frequency_days integer required
  • retention_days integer required

ProjectDetail

  • active boolean required
  • created_at string · date-time required
  • id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f
  • max_concurrency integer required — Maximum concurrent PHP workers. This setting cannot be changed through the API.
  • name string required
  • region string required
  • runtime string required
  • status string required
  • timeout integer required — HTTP worker timeout in seconds (default 30). WordPress login-cookie, admin-path, cron and internal operations use the maximum of 180 seconds.
  • updated_at string · date-time required
  • workspace_id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f

ProjectDomainOutput

  • checked_at string · date-time
  • created_at string · date-time required
  • error_code string
  • error_message string
  • id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f
  • name string required
  • primary boolean required
  • required_dns_records array of RequiredDNSRecord required
  • status string required One of: pending, checking, ok, error

ProjectFileEntry

  • etag string
  • is_dir boolean required
  • modified_at string · date-time required
  • name string required
  • path string required
  • size integer required

ProjectLogEventOutput

  • message string required
  • priority string required
  • request_id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f
  • timestamp string · date-time required

ProjectRuleOutput

  • actions array of RuleStatement required
  • active boolean required
  • conditions object required
  • created_at string · date-time required
  • id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f
  • name string required
  • priority integer required
  • updated_at string · date-time required

ProjectSummary

  • active boolean required
  • created_at string · date-time required
  • id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f
  • name string required
  • region string required
  • runtime string required
  • status string required
  • updated_at string · date-time required
  • workspace_id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f

ProjectUsageOutput

  • backup_size integer required
  • database_size integer required
  • datatransfer_out integer required
  • duration_average integer required
  • duration_total integer required
  • events_at string · date-time required
  • requests_total integer required
  • requests_worker integer required
  • responses_1xx integer required
  • responses_2xx integer required
  • responses_3xx integer required
  • responses_4xx integer required
  • responses_5xx integer required
  • storage_size integer required

ProjectUsageResponse

ProjectUsageTotals

  • backup_size integer required
  • database_size integer required
  • datatransfer_out integer required
  • duration_average integer required
  • duration_total integer required
  • requests_total integer required
  • requests_worker integer required
  • responses_1xx integer required
  • responses_2xx integer required
  • responses_3xx integer required
  • responses_4xx integer required
  • responses_5xx integer required
  • storage_size integer required

ProjectVariableOutput

  • id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f
  • name string required
  • sensitive boolean required
  • value string

RegionOutput

  • description string required
  • id string required

RequiredDNSRecord

  • name string required
  • purpose string required One of: traffic, certificate_validation
  • type string required One of: CNAME
  • value string required

RuleActionOption

  • allowed_values array of string — Domain of allowed values when this action takes one. Omitted for terminal actions that take no value (e.g. "end").
  • description string — Human-readable explanation of the action's effect.
  • fact string — Dotted fact key the action mutates. Omitted for terminal actions like "end".
  • operator string required — Action operator code (e.g. "set", "end").

RuleCatalogNotes

  • conditions_shape string required — How to build the conditions object: a JSON object containing one or more of 'all' (AND), 'any' (OR), or 'not' (negated AND). Each maps to an array of statements. Exactly {'all':[]} means match every request.
  • statement_shape string required — How to build a single rule statement from a catalog entry: copy fact/operator from the entry, then supply a single string 'value' (NOT 'values') chosen from the entry's 'allowed_values' domain.
  • terminal_action_end string required — Explanation of the special {"operator":"end"} action.

RuleConditionOption

  • allowed_values array of string required — Domain of allowed value strings. A single "*" entry means any string is accepted; a literal list like ["http","https"] means the value must be one of those exact strings. Each rule statement carries a single value (the request shape's "value" field), not this array.
  • description string — Human-readable note about when this fact is observable and how the engine evaluates it.
  • fact string required — Dotted fact key, e.g. "request.method". A trailing ".*" ("request.header.*") means any sub-key is accepted.
  • operators array of string required — Operator codes allowed for this fact when used inside conditions.all / .any / .not arrays.

RuleOptionsOutput

RuleStatement

  • fact string
  • operator string
  • value string

RuleTemplateOutput

  • actions array of RuleStatement required
  • conditions object required
  • description string
  • name string required
  • priority integer — Suggested execution priority; lower numbers run first.
  • requires_configuration boolean — Create an inactive copy and review site-specific values before enabling this template.

RuntimeOutput

  • created_at string · date-time required
  • deprecated_at string · date-time
  • description string required
  • id string required
  • updated_at string · date-time required

SelfUser

  • created_at string · date-time required
  • effective_scopes array of string required
  • email string required
  • id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f
  • name string required

StatementListItem

  • duration_ms integer
  • id string required
  • sql_preview string required
  • status string required
  • submitted_at string required

UpdateBillingInput

  • budget_alerts array of integer
  • budget_stop boolean
  • charge_amount integer
  • charge_threshold integer
  • monthly_budget integer

UpdateProjectBackupPolicyInput

  • frequency_days integer
  • retention_days integer

UpdateProjectDomainInput

  • primary boolean — Promote an exact domain to the project site domain. Wildcard domains cannot be primary.

UpdateProjectInput

  • active boolean
  • name string
  • runtime string
  • timeout integer — HTTP worker timeout in whole seconds (1–180).
  • workspace_id string

UpdateProjectRuleInput

  • actions array of RuleStatement
  • active boolean
  • conditions object
  • name string
  • priority number

UpdateProjectVariableInput

  • name string
  • sensitive boolean
  • value string

WPCommandListItem

  • command_preview string required
  • duration_ms integer
  • id string required
  • status string required
  • submitted_at string required

WorkspaceBillingTransferOutput

  • created_at string · date-time required
  • id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f
  • requested_by_email string required
  • requested_by_name string
  • requested_by_user_id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f
  • target_email string required
  • target_name string
  • target_user_id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f
  • updated_at string · date-time required
  • workspace_id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f

WorkspaceMemberOutput

  • created_at string · date-time required
  • email string required
  • expires_at string · date-time
  • invite_id string · uuid e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f
  • is_billing_user boolean required
  • mfa_enabled boolean
  • name string
  • role string required
  • status string required
  • updated_at string · date-time required
  • user_id string · uuid e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f

WorkspaceOutput

  • billing_user_id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f
  • created_at string · date-time required
  • id string · uuid required e.g. 01935d3d-9d8c-7a30-9b1f-3b3a8e1c5a2f
  • name string required
  • require_mfa boolean required
  • role string required
  • updated_at string · date-time required