# Environments ## List zone environments `client.zones.environments.list(EnvironmentListParamsparams, RequestOptionsoptions?): EnvironmentListResponse` **get** `/zones/{zone_id}/environments` List zone environments ### Parameters - `params: EnvironmentListParams` - `zone_id: string` Identifier of the zone. ### Returns - `EnvironmentListResponse` - `environments: Array` - `expression: string` - `locked_on_deployment: boolean | null` - `name: string` - `position: ListCursor` - `after?: string` - `before?: string` - `ref: string` - `version: number | null` - `http_application_id?: string | null` ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const environments = await client.zones.environments.list({ zone_id: 'zone_id' }); console.log(environments.environments); ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "environments": [ { "expression": "expression", "locked_on_deployment": true, "name": "name", "position": { "after": "yyy", "before": "xxx" }, "ref": "ref", "version": 0, "http_application_id": "http_application_id" } ] }, "success": true } ``` ## Create zone environments `client.zones.environments.create(EnvironmentCreateParamsparams, RequestOptionsoptions?): EnvironmentCreateResponse` **post** `/zones/{zone_id}/environments` Create zone environments ### Parameters - `params: EnvironmentCreateParams` - `zone_id: string` Path param: Identifier of the zone. - `environments: Array` Body param - `expression: string` - `locked_on_deployment: boolean | null` - `name: string` - `position: ListCursor` - `after?: string` - `before?: string` - `ref: string` - `version: number | null` - `http_application_id?: string | null` ### Returns - `EnvironmentCreateResponse` - `environments: Array` - `expression: string` - `locked_on_deployment: boolean | null` - `name: string` - `position: ListCursor` - `after?: string` - `before?: string` - `ref: string` - `version: number | null` - `http_application_id?: string | null` ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const environment = await client.zones.environments.create({ zone_id: 'zone_id', environments: [ { expression: 'expression', locked_on_deployment: true, name: 'name', position: {}, ref: 'ref', version: 0, }, ], }); console.log(environment.environments); ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "environments": [ { "expression": "expression", "locked_on_deployment": true, "name": "name", "position": { "after": "yyy", "before": "xxx" }, "ref": "ref", "version": 0, "http_application_id": "http_application_id" } ] }, "success": true } ``` ## Upsert zone environments `client.zones.environments.update(EnvironmentUpdateParamsparams, RequestOptionsoptions?): EnvironmentUpdateResponse` **put** `/zones/{zone_id}/environments` Upsert zone environments ### Parameters - `params: EnvironmentUpdateParams` - `zone_id: string` Path param: Identifier of the zone. - `environments: Array` Body param - `expression: string` - `locked_on_deployment: boolean | null` - `name: string` - `position: ListCursor` - `after?: string` - `before?: string` - `ref: string` - `version: number | null` - `http_application_id?: string | null` ### Returns - `EnvironmentUpdateResponse` - `environments: Array` - `expression: string` - `locked_on_deployment: boolean | null` - `name: string` - `position: ListCursor` - `after?: string` - `before?: string` - `ref: string` - `version: number | null` - `http_application_id?: string | null` ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const environment = await client.zones.environments.update({ zone_id: 'zone_id', environments: [ { expression: 'expression', locked_on_deployment: true, name: 'name', position: {}, ref: 'ref', version: 0, }, ], }); console.log(environment.environments); ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "environments": [ { "expression": "expression", "locked_on_deployment": true, "name": "name", "position": { "after": "yyy", "before": "xxx" }, "ref": "ref", "version": 0, "http_application_id": "http_application_id" } ] }, "success": true } ``` ## Partially update zone environments `client.zones.environments.edit(EnvironmentEditParamsparams, RequestOptionsoptions?): EnvironmentEditResponse` **patch** `/zones/{zone_id}/environments` Partially update zone environments ### Parameters - `params: EnvironmentEditParams` - `zone_id: string` Path param: Identifier of the zone. - `environments: Array` Body param - `expression: string` - `locked_on_deployment: boolean | null` - `name: string` - `position: ListCursor` - `after?: string` - `before?: string` - `ref: string` - `version: number | null` - `http_application_id?: string | null` ### Returns - `EnvironmentEditResponse` - `environments: Array` - `expression: string` - `locked_on_deployment: boolean | null` - `name: string` - `position: ListCursor` - `after?: string` - `before?: string` - `ref: string` - `version: number | null` - `http_application_id?: string | null` ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.zones.environments.edit({ zone_id: 'zone_id', environments: [ { expression: 'expression', locked_on_deployment: true, name: 'name', position: {}, ref: 'ref', version: 0, }, ], }); console.log(response.environments); ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "environments": [ { "expression": "expression", "locked_on_deployment": true, "name": "name", "position": { "after": "yyy", "before": "xxx" }, "ref": "ref", "version": 0, "http_application_id": "http_application_id" } ] }, "success": true } ``` ## Delete zone environment `client.zones.environments.delete(stringenvironmentId, EnvironmentDeleteParamsparams, RequestOptionsoptions?): EnvironmentDeleteResponse` **delete** `/zones/{zone_id}/environments/{environment_id}` Delete zone environment ### Parameters - `environmentId: string` - `params: EnvironmentDeleteParams` - `zone_id: string` Identifier of the zone. ### Returns - `EnvironmentDeleteResponse` - `environments: Array` - `expression: string` - `locked_on_deployment: boolean | null` - `name: string` - `position: ListCursor` - `after?: string` - `before?: string` - `ref: string` - `version: number | null` - `http_application_id?: string | null` ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const environment = await client.zones.environments.delete('environment_id', { zone_id: 'zone_id', }); console.log(environment.environments); ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "environments": [ { "expression": "expression", "locked_on_deployment": true, "name": "name", "position": { "after": "yyy", "before": "xxx" }, "ref": "ref", "version": 0, "http_application_id": "http_application_id" } ] }, "success": true } ``` ## Roll back zone environment `client.zones.environments.rollback(stringenvironmentId, EnvironmentRollbackParamsparams, RequestOptionsoptions?): EnvironmentRollbackResponse` **post** `/zones/{zone_id}/environments/{environment_id}/rollback` Roll back zone environment ### Parameters - `environmentId: string` - `params: EnvironmentRollbackParams` - `zone_id: string` Identifier of the zone. ### Returns - `EnvironmentRollbackResponse` - `environments: Array` - `expression: string` - `locked_on_deployment: boolean | null` - `name: string` - `position: ListCursor` - `after?: string` - `before?: string` - `ref: string` - `version: number | null` - `http_application_id?: string | null` ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.zones.environments.rollback('environment_id', { zone_id: 'zone_id' }); console.log(response.environments); ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "environments": [ { "expression": "expression", "locked_on_deployment": true, "name": "name", "position": { "after": "yyy", "before": "xxx" }, "ref": "ref", "version": 0, "http_application_id": "http_application_id" } ] }, "success": true } ``` ## Domain Types ### Environment List Response - `EnvironmentListResponse` - `environments: Array` - `expression: string` - `locked_on_deployment: boolean | null` - `name: string` - `position: ListCursor` - `after?: string` - `before?: string` - `ref: string` - `version: number | null` - `http_application_id?: string | null` ### Environment Create Response - `EnvironmentCreateResponse` - `environments: Array` - `expression: string` - `locked_on_deployment: boolean | null` - `name: string` - `position: ListCursor` - `after?: string` - `before?: string` - `ref: string` - `version: number | null` - `http_application_id?: string | null` ### Environment Update Response - `EnvironmentUpdateResponse` - `environments: Array` - `expression: string` - `locked_on_deployment: boolean | null` - `name: string` - `position: ListCursor` - `after?: string` - `before?: string` - `ref: string` - `version: number | null` - `http_application_id?: string | null` ### Environment Edit Response - `EnvironmentEditResponse` - `environments: Array` - `expression: string` - `locked_on_deployment: boolean | null` - `name: string` - `position: ListCursor` - `after?: string` - `before?: string` - `ref: string` - `version: number | null` - `http_application_id?: string | null` ### Environment Delete Response - `EnvironmentDeleteResponse` - `environments: Array` - `expression: string` - `locked_on_deployment: boolean | null` - `name: string` - `position: ListCursor` - `after?: string` - `before?: string` - `ref: string` - `version: number | null` - `http_application_id?: string | null` ### Environment Rollback Response - `EnvironmentRollbackResponse` - `environments: Array` - `expression: string` - `locked_on_deployment: boolean | null` - `name: string` - `position: ListCursor` - `after?: string` - `before?: string` - `ref: string` - `version: number | null` - `http_application_id?: string | null`