environments

Creates, updates, deletes, gets or lists an environments resource.

Overview

Name	environments
Type	Resource
Id	cloudflare.zones.environments

Fields

The following fields are returned by SELECT queries:

list

Successfully listed zone environments.

Name	Datatype	Description
name	string
http_application_id	string
expression	string
locked_on_deployment	boolean
position	object
ref	string
version	integer (int64)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	zone_id
create	insert	zone_id, environments
edit	update	zone_id, environments
update	replace	zone_id, environments
delete	delete	zone_id, environment_id
rollback	exec	zone_id, environment_id

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environment_id	string	Reference identifier for the environment.
zone_id	string	The Cloudflare zone ID.

SELECT examples

list

Successfully listed zone environments.

SELECT
name,
http_application_id,
expression,
locked_on_deployment,
position,
ref,
version
FROM cloudflare.zones.environments
WHERE zone_id = '{{ zone_id }}' -- required
;

INSERT examples

create

No description available.

INSERT INTO cloudflare.zones.environments (
environments,
zone_id
)
SELECT 
'{{ environments }}' /* required */,
'{{ zone_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: environments
props:
  - name: zone_id
    value: "{{ zone_id }}"
    description: Required parameter for the environments resource.
  - name: environments
    value:
      - expression: "{{ expression }}"
        http_application_id: "{{ http_application_id }}"
        locked_on_deployment: {{ locked_on_deployment }}
        name: "{{ name }}"
        position:
          after: "{{ after }}"
          before: "{{ before }}"
        ref: "{{ ref }}"
        version: {{ version }}

UPDATE examples

edit

No description available.

UPDATE cloudflare.zones.environments
SET 
environments = '{{ environments }}'
WHERE 
zone_id = '{{ zone_id }}' --required
AND environments = '{{ environments }}' --required
RETURNING
errors,
messages,
result,
success;

REPLACE examples

update

No description available.

REPLACE cloudflare.zones.environments
SET 
environments = '{{ environments }}'
WHERE 
zone_id = '{{ zone_id }}' --required
AND environments = '{{ environments }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

No description available.

DELETE FROM cloudflare.zones.environments
WHERE zone_id = '{{ zone_id }}' --required
AND environment_id = '{{ environment_id }}' --required
;

Lifecycle Methods

rollback

Successfully rolled back zone environment.

EXEC cloudflare.zones.environments.rollback 
@zone_id='{{ zone_id }}' --required, 
@environment_id='{{ environment_id }}' --required
;