deployment_gates

Creates, updates, deletes, gets or lists a deployment_gates resource.

Overview

Name	deployment_gates
Type	Resource
Id	datadog.software_delivery.deployment_gates

Fields

The following fields are returned by SELECT queries:

get_deployment_gate

Name	Datatype	Description
id	string	Unique identifier of the deployment gate. (example: 1111-2222-3333-4444-555566667777)
attributes	object	Basic information about a deployment gate.
type	string	Deployment gate resource type. (deployment_gate) (example: deployment_gate)

list_deployment_gates

Name	Datatype	Description
id	string	Unique identifier of the deployment gate. (example: 1111-2222-3333-4444-555566667777)
attributes	object	Basic information about a deployment gate.
type	string	Deployment gate resource type. (deployment_gate) (example: deployment_gate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_deployment_gate	select	id		Endpoint to get a deployment gate.
list_deployment_gates	select		page[cursor], page[size]	Returns a paginated list of all deployment gates for the organization.<br />Use page&#91;cursor&#93; and page&#91;size&#93; query parameters to paginate through results.
create_deployment_gate	insert	data		Endpoint to create a deployment gate.
update_deployment_gate	replace	id, data		Endpoint to update a deployment gate.
delete_deployment_gate	delete	id		Endpoint to delete a deployment gate. Rules associated with the gate are also deleted.

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
id	string	The ID of the deployment gate.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
page[cursor]	string	Cursor for pagination. Use the meta.page.next_cursor value from the previous response.
page[size]	integer (int64)	Number of results per page. Defaults to 50. Must be between 1 and 1000.

SELECT examples

get_deployment_gate

Endpoint to get a deployment gate.

SELECT
id,
attributes,
type
FROM datadog.software_delivery.deployment_gates
WHERE id = '{{ id }}' -- required
;

list_deployment_gates

Returns a paginated list of all deployment gates for the organization.<br />Use page[cursor] and page[size] query parameters to paginate through results.

SELECT
id,
attributes,
type
FROM datadog.software_delivery.deployment_gates
WHERE page[cursor] = '{{ page[cursor] }}'
AND page[size] = '{{ page[size] }}'
;

INSERT examples

create_deployment_gate

Endpoint to create a deployment gate.

INSERT INTO datadog.software_delivery.deployment_gates (
data
)
SELECT 
'{{ data }}' /* required */
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: deployment_gates
props:
  - name: data
    description: |
      Parameters for creating a deployment gate.
    value:
      attributes:
        dry_run: {{ dry_run }}
        env: "{{ env }}"
        identifier: "{{ identifier }}"
        service: "{{ service }}"
      type: "{{ type }}"

REPLACE examples

update_deployment_gate

Endpoint to update a deployment gate.

REPLACE datadog.software_delivery.deployment_gates
SET 
data = '{{ data }}'
WHERE 
id = '{{ id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_deployment_gate

Endpoint to delete a deployment gate. Rules associated with the gate are also deleted.

DELETE FROM datadog.software_delivery.deployment_gates
WHERE id = '{{ id }}' --required
;