API Reference

Zones

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Environments

List zone environments

client.zones.environments.list(EnvironmentListParams { zone_id } params, RequestOptionsoptions?): EnvironmentListResponse { environments }

GET/zones/{zone_id}/environments

Create zone environments

client.zones.environments.create(EnvironmentCreateParams { zone_id, environments } params, RequestOptionsoptions?): EnvironmentCreateResponse { environments }

POST/zones/{zone_id}/environments

Upsert zone environments

client.zones.environments.update(EnvironmentUpdateParams { zone_id, environments } params, RequestOptionsoptions?): EnvironmentUpdateResponse { environments }

PUT/zones/{zone_id}/environments

Partially update zone environments

client.zones.environments.edit(EnvironmentEditParams { zone_id, environments } params, RequestOptionsoptions?): EnvironmentEditResponse { environments }

PATCH/zones/{zone_id}/environments

Delete zone environment

client.zones.environments.delete(stringenvironmentId, EnvironmentDeleteParams { zone_id } params, RequestOptionsoptions?): EnvironmentDeleteResponse { environments }

DELETE/zones/{zone_id}/environments/{environment_id}

Roll back zone environment

client.zones.environments.rollback(stringenvironmentId, EnvironmentRollbackParams { zone_id } params, RequestOptionsoptions?): EnvironmentRollbackResponse { environments }

POST/zones/{zone_id}/environments/{environment_id}/rollback

ModelsExpand Collapse

EnvironmentListResponse { environments }

environments: Array<Environment>

expression: string

locked_on_deployment: boolean | null

name: string

position: ListCursor { after, before }

ref: string

version: number | null

formatint64

http_application_id?: string | null

EnvironmentCreateResponse { environments }

environments: Array<Environment>

expression: string

locked_on_deployment: boolean | null

name: string

position: ListCursor { after, before }

ref: string

version: number | null

formatint64

http_application_id?: string | null

EnvironmentUpdateResponse { environments }

environments: Array<Environment>

expression: string

locked_on_deployment: boolean | null

name: string

position: ListCursor { after, before }

ref: string

version: number | null

formatint64

http_application_id?: string | null

EnvironmentEditResponse { environments }

environments: Array<Environment>

expression: string

locked_on_deployment: boolean | null

name: string

position: ListCursor { after, before }

ref: string

version: number | null

formatint64

http_application_id?: string | null

EnvironmentDeleteResponse { environments }

environments: Array<Environment>

expression: string

locked_on_deployment: boolean | null

name: string

position: ListCursor { after, before }

ref: string

version: number | null

formatint64

http_application_id?: string | null

EnvironmentRollbackResponse { environments }

environments: Array<Environment>

expression: string

locked_on_deployment: boolean | null

name: string

position: ListCursor { after, before }

ref: string

version: number | null

formatint64

http_application_id?: string | null