Note : This endpoint is in preview and may be subject to change.
If you have any feedback, contact Datadog support .
POST https://api.ap1.datadoghq.com/api/v2/deployment_gates https://api.ap2.datadoghq.com/api/v2/deployment_gates https://api.datadoghq.eu/api/v2/deployment_gates https://api.ddog-gov.com/api/v2/deployment_gates https://api.us2.ddog-gov.com/api/v2/deployment_gates https://api.uk1.datadoghq.com/api/v2/deployment_gates https://api.datadoghq.com/api/v2/deployment_gates https://api.us3.datadoghq.com/api/v2/deployment_gates https://api.us5.datadoghq.com/api/v2/deployment_gates
概要 Endpoint to create a deployment gate.
This endpoint requires the deployment_gates_write permission.
リクエスト Body Data (required)
Expand All
Parameters for creating a deployment gate.
Parameters for creating a deployment gate.
Whether this gate is run in dry-run mode.
The environment of the deployment gate.
The identifier of the deployment gate.
default: default
The service of the deployment gate.
Deployment gate resource type.
Allowed enum values: deployment_gate
{
"data" : {
"attributes" : {
"dry_run" : false ,
"env" : "production" ,
"identifier" : "my-gate-1" ,
"service" : "my-service"
},
"type" : "deployment_gate"
}
} 応答 OK
Response for a deployment gate.
Expand All
Data for a deployment gate.
Basic information about a deployment gate.
The timestamp when the deployment gate was created.
Information about the user who created the deployment gate.
The handle of the user who created the deployment rule.
The ID of the user who created the deployment rule.
The name of the user who created the deployment rule.
Whether this gate is run in dry-run mode.
The environment of the deployment gate.
The identifier of the deployment gate.
The service of the deployment gate.
The timestamp when the deployment gate was last updated.
Information about the user who updated the deployment gate.
The handle of the user who updated the deployment rule.
The ID of the user who updated the deployment rule.
The name of the user who updated the deployment rule.
Unique identifier of the deployment gate.
Deployment gate resource type.
Allowed enum values: deployment_gate
{
"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"
}
} Bad request.
{
"errors" : [
{
"detail" : "Malformed payload" ,
"status" : "400" ,
"title" : "Bad Request"
}
]
} Unauthorized
{
"errors" : [
"Bad Request"
]
} Forbidden
{
"errors" : [
"Bad Request"
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Internal Server Error
{
"errors" : [
{
"detail" : "Malformed payload" ,
"status" : "400" ,
"title" : "Bad Request"
}
]
} コード例 コピー
## default
#
# Curl command curl -X POST "https://api.ap1.datadoghq.com "https://api.ap2.datadoghq.com "https://api.datadoghq.eu "https://api.ddog-gov.com "https://api.us2.ddog-gov.com "https://api.uk1.datadoghq.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/deployment_gates " \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} " \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"env": "production",
"identifier": "pre",
"service": "my-service"
},
"type": "deployment_gate"
}
}
EOF
// Create deployment gate 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 () {
body := datadogV2 . CreateDeploymentGateParams {
Data : datadogV2 . CreateDeploymentGateParamsData {
Attributes : datadogV2 . CreateDeploymentGateParamsDataAttributes {
DryRun : datadog . PtrBool ( false ),
Env : "production" ,
Identifier : datadog . PtrString ( "my-gate-1" ),
Service : "my-service" ,
},
Type : datadogV2 . DEPLOYMENTGATEDATATYPE_DEPLOYMENT_GATE ,
},
}
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
configuration . SetUnstableOperationEnabled ( "v2.CreateDeploymentGate" , true )
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewDeploymentGatesApi ( apiClient )
resp , r , err := api . CreateDeploymentGate ( ctx , body )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `DeploymentGatesApi.CreateDeploymentGate`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `DeploymentGatesApi.CreateDeploymentGate`:\n%s\n" , responseContent )
}
Instructions First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" go run "main.go"
// Create deployment gate 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.CreateDeploymentGateParams ;
import com.datadog.api.client.v2.model.CreateDeploymentGateParamsData ;
import com.datadog.api.client.v2.model.CreateDeploymentGateParamsDataAttributes ;
import com.datadog.api.client.v2.model.DeploymentGateDataType ;
import com.datadog.api.client.v2.model.DeploymentGateResponse ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
defaultClient . setUnstableOperationEnabled ( "v2.createDeploymentGate" , true );
DeploymentGatesApi apiInstance = new DeploymentGatesApi ( defaultClient );
CreateDeploymentGateParams body =
new CreateDeploymentGateParams ()
. data (
new CreateDeploymentGateParamsData ()
. attributes (
new CreateDeploymentGateParamsDataAttributes ()
. dryRun ( false )
. env ( "production" )
. identifier ( "my-gate-1" )
. service ( "my-service" ))
. type ( DeploymentGateDataType . DEPLOYMENT_GATE ));
try {
DeploymentGateResponse result = apiInstance . createDeploymentGate ( body );
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling DeploymentGatesApi#createDeploymentGate" );
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 and then save the example to Example.java and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" java "Example.java"
"""
Create deployment gate returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.deployment_gates_api import DeploymentGatesApi
from datadog_api_client.v2.model.create_deployment_gate_params import CreateDeploymentGateParams
from datadog_api_client.v2.model.create_deployment_gate_params_data import CreateDeploymentGateParamsData
from datadog_api_client.v2.model.create_deployment_gate_params_data_attributes import (
CreateDeploymentGateParamsDataAttributes ,
)
from datadog_api_client.v2.model.deployment_gate_data_type import DeploymentGateDataType
body = CreateDeploymentGateParams (
data = CreateDeploymentGateParamsData (
attributes = CreateDeploymentGateParamsDataAttributes (
dry_run = False ,
env = "production" ,
identifier = "my-gate-1" ,
service = "my-service" ,
),
type = DeploymentGateDataType . DEPLOYMENT_GATE ,
),
)
configuration = Configuration ()
configuration . unstable_operations [ "create_deployment_gate" ] = True
with ApiClient ( configuration ) as api_client :
api_instance = DeploymentGatesApi ( api_client )
response = api_instance . create_deployment_gate ( body = body )
print ( response )
Instructions First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python3 "example.py"
# Create deployment gate returns "OK" response
require "datadog_api_client"
DatadogAPIClient . configure do | config |
config . unstable_operations [ "v2.create_deployment_gate" . to_sym ] = true
end
api_instance = DatadogAPIClient :: V2 :: DeploymentGatesAPI . new
body = DatadogAPIClient :: V2 :: CreateDeploymentGateParams . new ({
data : DatadogAPIClient :: V2 :: CreateDeploymentGateParamsData . new ({
attributes : DatadogAPIClient :: V2 :: CreateDeploymentGateParamsDataAttributes . new ({
dry_run : false ,
env : "production" ,
identifier : "my-gate-1" ,
service : "my-service" ,
}),
type : DatadogAPIClient :: V2 :: DeploymentGateDataType :: DEPLOYMENT_GATE ,
}),
})
p api_instance . create_deployment_gate ( body )
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
// Create deployment gate returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_deployment_gates ::DeploymentGatesAPI ;
use datadog_api_client ::datadogV2 ::model ::CreateDeploymentGateParams ;
use datadog_api_client ::datadogV2 ::model ::CreateDeploymentGateParamsData ;
use datadog_api_client ::datadogV2 ::model ::CreateDeploymentGateParamsDataAttributes ;
use datadog_api_client ::datadogV2 ::model ::DeploymentGateDataType ;
#[tokio::main]
async fn main () {
let body = CreateDeploymentGateParams ::new ( CreateDeploymentGateParamsData ::new (
CreateDeploymentGateParamsDataAttributes ::new (
"production" . to_string (),
"my-service" . to_string (),
)
. dry_run ( false )
. identifier ( "my-gate-1" . to_string ()),
DeploymentGateDataType ::DEPLOYMENT_GATE ,
));
let mut configuration = datadog ::Configuration ::new ();
configuration . set_unstable_operation_enabled ( "v2.CreateDeploymentGate" , true );
let api = DeploymentGatesAPI ::with_config ( configuration );
let resp = api . create_deployment_gate ( body ). await ;
if let Ok ( value ) = resp {
println! ( " {:#?} " , value );
} else {
println! ( " {:#?} " , resp . unwrap_err ());
}
}
Instructions First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" cargo run
/**
* Create deployment gate returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
configuration . unstableOperations [ "v2.createDeploymentGate" ] = true ;
const apiInstance = new v2 . DeploymentGatesApi ( configuration );
const params : v2.DeploymentGatesApiCreateDeploymentGateRequest = {
body : {
data : {
attributes : {
dryRun : false ,
env : "production" ,
identifier : "my-gate-1" ,
service : "my-service" ,
},
type : "deployment_gate" ,
},
},
};
apiInstance
. createDeploymentGate ( params )
. then (( data : v2.DeploymentGateResponse ) => {
console . log (
"API called successfully. Returned data: " + JSON . stringify ( data )
);
})
. catch (( error : any ) => console . error ( error ));
Instructions First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" tsc "example.ts"