--- title: Get all deployment gates description: Returns a paginated list of all deployment gates for the organization. Use page[cursor] and page[size] query parameters to paginate through results. breadcrumbs: Documentación > API > Get all deployment gates --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Get all deployment gates ## v2 (latest) {% alert level="warning" %} **Note**: This endpoint is in preview and may be subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help.md). {% /alert %} | Datadog site | API endpoint | | ----------------- | --------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/deployment_gates | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/deployment_gates | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/deployment_gates | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/deployment_gates | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/deployment_gates | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/deployment_gates | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/deployment_gates | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/deployment_gates | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/deployment_gates | ### Overview Returns a paginated list of all deployment gates for the organization. Use `page[cursor]` and `page[size]` query parameters to paginate through results. This endpoint requires the `deployment_gates_read` permission. ### Arguments #### Query Strings | Field | Type | Description | | ------------------ | ------- | -------------------------------------------------------------------------------------------------------------------- | | filter[service] | string | Service name. | | filter[env] | string | Environment name. | | filter[identifier] | string | Gate identifier. | | filter[dry_run] | boolean | Dry-run state. | | page[cursor] | string | Cursor for pagination. Use the `meta.page.next_cursor` value from the previous response. Invalid cursors return 400. | | page[size] | integer | Number of results per page. Defaults to 50. Must be between 1 and 1000. Default: `50`. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response containing a paginated list of deployment gates. | Parent field | Field | Type | Description | | ------------ | ----------------------- | --------- | -------------------------------------------------------------------------------------- | | | data | [object] | Array of deployment gates. | | data | attributes [*required*] | object | Basic information about a deployment gate. | | attributes | created_at [*required*] | date-time | The timestamp when the deployment gate was created. | | attributes | created_by [*required*] | object | Information about the user who created the deployment gate. | | created_by | handle | string | The handle of the user who created the deployment rule. | | created_by | id [*required*] | string | The ID of the user who created the deployment rule. | | created_by | name | string | The name of the user who created the deployment rule. | | attributes | dry_run [*required*] | boolean | Whether this gate is run in dry-run mode. | | attributes | env [*required*] | string | The environment of the deployment gate. | | attributes | identifier [*required*] | string | The identifier of the deployment gate. | | attributes | service [*required*] | string | The service of the deployment gate. | | attributes | updated_at | date-time | The timestamp when the deployment gate was last updated. | | attributes | updated_by | object | Information about the user who updated the deployment gate. | | updated_by | handle | string | The handle of the user who updated the deployment rule. | | updated_by | id [*required*] | string | The ID of the user who updated the deployment rule. | | updated_by | name | string | The name of the user who updated the deployment rule. | | data | id [*required*] | string | Unique identifier of the deployment gate. | | data | type [*required*] | enum | Deployment gate resource type. Allowed enum values: `deployment_gate`. | | | meta | object | Metadata for a list of deployment gates response. | | meta | page | object | Pagination information for a list of deployment gates. | | page | cursor | string | The cursor used for the current page. | | page | next_cursor | string | The cursor to use to fetch the next page. This is absent when there are no more pages. | | page | size | int64 | The number of results per page. Default: `50`. | {% /tab %} {% tab label="Example" %} ```json { "data": [ { "attributes": { "created_at": "2021-01-01T00:00:00Z", "created_by": { "handle": "test-user", "id": "1111-2222-3333-4444-555566667777", "name": "Test User" }, "dry_run": false, "env": "production", "identifier": "pre", "service": "my-service", "updated_at": "2021-01-01T00:00:00Z", "updated_by": { "handle": "test-user", "id": "1111-2222-3333-4444-555566667777", "name": "Test User" } }, "id": "1111-2222-3333-4444-555566667777", "type": "deployment_gate" } ], "meta": { "page": { "cursor": "string", "next_cursor": "string", "size": "integer" } } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad request. {% tabs %} {% tab label="Model" %} Bad request. | Parent field | Field | Type | Description | | ------------ | ------ | -------- | ------------------ | | | errors | [object] | Structured errors. | | errors | detail | string | Error message. | | errors | status | string | Error code. | | errors | title | string | Error title. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Malformed payload", "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="401" %} Unauthorized {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="500" %} Internal Server Error {% tabs %} {% tab label="Model" %} Errors occurred. | Parent field | Field | Type | Description | | ------------ | ------ | -------- | ------------------ | | | errors | [object] | Structured errors. | | errors | detail | string | Error message. | | errors | status | string | Error code. | | errors | title | string | Error title. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Malformed payload", "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v2/deployment_gates" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get all deployment gates returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.ListDeploymentGates", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewDeploymentGatesApi(apiClient) resp, r, err := api.ListDeploymentGates(ctx, *datadogV2.NewListDeploymentGatesOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DeploymentGatesApi.ListDeploymentGates`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DeploymentGatesApi.ListDeploymentGates`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Get all deployment gates returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.DeploymentGatesApi; import com.datadog.api.client.v2.model.DeploymentGatesListResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); defaultClient.setUnstableOperationEnabled("v2.listDeploymentGates", true); DeploymentGatesApi apiInstance = new DeploymentGatesApi(defaultClient); try { DeploymentGatesListResponse result = apiInstance.listDeploymentGates(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DeploymentGatesApi#listDeploymentGates"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Get all deployment gates returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.deployment_gates_api import DeploymentGatesApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] configuration.unstable_operations["list_deployment_gates"] = True with ApiClient(configuration) as api_client: api_instance = DeploymentGatesApi(api_client) response = api_instance.list_deployment_gates() print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Get all deployment gates returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] config.unstable_operations["v2.list_deployment_gates".to_sym] = true end api_instance = DatadogAPIClient::V2::DeploymentGatesAPI.new p api_instance.list_deployment_gates() ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Get all deployment gates returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_deployment_gates::DeploymentGatesAPI; use datadog_api_client::datadogV2::api_deployment_gates::ListDeploymentGatesOptionalParams; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.list_deployment_gates", true); let api = DeploymentGatesAPI::with_config(configuration); let resp = api .list_deployment_gates(ListDeploymentGatesOptionalParams::default()) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Get all deployment gates returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); configuration.unstableOperations["v2.listDeploymentGates"] = true; const apiInstance = new v2.DeploymentGatesApi(configuration); apiInstance .listDeploymentGates() .then((data: v2.DeploymentGatesListResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}