Create deployment rule
警告Note: This endpoint is in preview and may be subject to change.
If you have any feedback, contact Datadog support.
POST
https://api.datadoghq.com/api/v2/deployment_gates/{gate_id}/ruleshttps://api.us3.datadoghq.com/api/v2/deployment_gates/{gate_id}/ruleshttps://api.us5.datadoghq.com/api/v2/deployment_gates/{gate_id}/ruleshttps://api.datadoghq.eu/api/v2/deployment_gates/{gate_id}/ruleshttps://api.ap1.datadoghq.com/api/v2/deployment_gates/{gate_id}/ruleshttps://api.ap2.datadoghq.com/api/v2/deployment_gates/{gate_id}/ruleshttps://api.uk1.datadoghq.com/api/v2/deployment_gates/{gate_id}/ruleshttps://api.ddog-gov.com/api/v2/deployment_gates/{gate_id}/ruleshttps://api.us2.ddog-gov.com/api/v2/deployment_gates/{gate_id}/rules概要
Endpoint to create a deployment rule. A gate for the rule must already exist.
引数
パスパラメーター
名前
タイプ
説明
gate_id [required]string
The ID of the deployment gate.
リクエスト
Body Data (required)
フィールド
タイプ
説明
dataobject
Parameters for creating a deployment rule.
attributes [required]object
Parameters for creating a deployment rule.
dry_runboolean
Whether this rule is run in dry-run mode.
falsename [required]string
The name of the deployment rule.
options [required]<oneOf>
Options for deployment rule response representing either faulty deployment detection or monitor options.
Object 1object
Faulty deployment detection options for deployment rules.
allowed_resources[string]
Resources to include in faulty deployment detection. Mutually exclusive with excluded_resources.
durationint64
The duration for faulty deployment detection.
excluded_resources[string]
Resources to exclude from faulty deployment detection.
Object 2object
Monitor query options for deployment rules.
durationint64
Seconds the monitor needs to stay in OK status for the rule to pass.
fail_on_no_databoolean
Whether the rule should fail if a matching monitor group is in a NO DATA state.
truefail_on_no_groups_foundboolean
Whether the rule should fail if no monitor groups are found for the query.
falsequery [required]string
A query that selects the monitors to evaluate.
warmupint64
Seconds to wait after a deployment starts before evaluating the monitor's status.
0Object 3object
Specific monitor options for deployment rules.
durationint64
Seconds the monitors need to stay in OK status for the rule to pass.
fail_on_no_databoolean
Whether the rule should fail if a selected monitor group is in a NO DATA state.
truefail_on_no_groups_foundboolean
Whether the rule should fail if no monitor groups are found for the selected monitors.
falsemonitor_ids [required][object]
A non-empty list of specific monitors to evaluate.
groups [required][string]
The exact monitor group names to evaluate. An empty array evaluates all groups.
id [required]string
The monitor's decimal ID.
warmupint64
Seconds to wait after a deployment starts before evaluating the monitors' statuses.
0type [required]string
The type of the deployment rule (faulty_deployment_detection or monitor).
type [required]enum
Deployment rule resource type.
Allowed enum values:
deployment_ruleCreate deployment rule returns "OK" response
{
"data": {
"attributes": {
"dry_run": false,
"name": "My deployment rule",
"options": {
"excluded_resources": []
},
"type": "faulty_deployment_detection"
},
"type": "deployment_rule"
}
}Create monitor deployment rule with monitor IDs returns "OK" response
{
"data": {
"attributes": {
"dry_run": false,
"name": "Specific monitor deployment rule",
"options": {
"monitor_ids": [
{
"id": "7",
"groups": []
}
]
},
"type": "monitor"
},
"type": "deployment_rule"
}
}Create monitor deployment rule with query returns "OK" response
{
"data": {
"attributes": {
"dry_run": false,
"name": "Query monitor deployment rule",
"options": {
"query": "service:transaction-backend env:production"
},
"type": "monitor"
},
"type": "deployment_rule"
}
}応答
OK
Response for a deployment rule.
フィールド
タイプ
説明
dataobject
Data for a deployment rule.
attributes [required]object
Basic information about a deployment rule.
created_at [required]date-time
The timestamp when the deployment rule was created.
created_by [required]object
Information about the user who created the deployment rule.
handlestring
The handle of the user who created the deployment rule.
id [required]string
The ID of the user who created the deployment rule.
namestring
The name of the user who created the deployment rule.
dry_run [required]boolean
Whether this rule is run in dry-run mode.
gate_id [required]string
The ID of the deployment gate.
name [required]string
The name of the deployment rule.
options [required]<oneOf>
Options for deployment rule response representing either faulty deployment detection or monitor options.
Object 1object
Faulty deployment detection options for deployment rules.
allowed_resources[string]
Resources to include in faulty deployment detection. Mutually exclusive with excluded_resources.
durationint64
The duration for faulty deployment detection.
excluded_resources[string]
Resources to exclude from faulty deployment detection.
Object 2object
Monitor query options for deployment rules.
durationint64
Seconds the monitor needs to stay in OK status for the rule to pass.
fail_on_no_databoolean
Whether the rule should fail if a matching monitor group is in a NO DATA state.
truefail_on_no_groups_foundboolean
Whether the rule should fail if no monitor groups are found for the query.
falsequery [required]string
A query that selects the monitors to evaluate.
warmupint64
Seconds to wait after a deployment starts before evaluating the monitor's status.
0Object 3object
Specific monitor options for deployment rules.
durationint64
Seconds the monitors need to stay in OK status for the rule to pass.
fail_on_no_databoolean
Whether the rule should fail if a selected monitor group is in a NO DATA state.
truefail_on_no_groups_foundboolean
Whether the rule should fail if no monitor groups are found for the selected monitors.
falsemonitor_ids [required][object]
A non-empty list of specific monitors to evaluate.
groups [required][string]
The exact monitor group names to evaluate. An empty array evaluates all groups.
id [required]string
The monitor's decimal ID.
warmupint64
Seconds to wait after a deployment starts before evaluating the monitors' statuses.
0type [required]enum
The type of the deployment rule.
Allowed enum values:
faulty_deployment_detection, monitorupdated_atdate-time
The timestamp when the deployment rule was last updated.
updated_byobject
Information about the user who updated the deployment rule.
handlestring
The handle of the user who updated the deployment rule.
id [required]string
The ID of the user who updated the deployment rule.
namestring
The name of the user who updated the deployment rule.
id [required]string
Unique identifier of the deployment rule.
type [required]enum
Deployment rule resource type.
Allowed enum values:
deployment_rule{
"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,
"gate_id": "1111-2222-3333-4444-555566667777",
"name": "My deployment rule",
"options": {
"allowed_resources": [
"resource1",
"resource2"
],
"duration": 3600,
"excluded_resources": [
"resource1",
"resource2"
]
},
"type": "faulty_deployment_detection",
"updated_at": "2019-09-19T10:00:00.000Z",
"updated_by": {
"handle": "test-user",
"id": "1111-2222-3333-4444-555566667777",
"name": "Test User"
}
},
"id": "1111-2222-3333-4444-555566667777",
"type": "deployment_rule"
}
}Bad request.
Bad request.
フィールド
タイプ
説明
errors[object]
Structured errors.
detailstring
Error message.
statusstring
Error code.
titlestring
Error title.
{
"errors": [
{
"detail": "Malformed payload",
"status": "400",
"title": "Bad Request"
}
]
}Unauthorized
API error response.
フィールド
タイプ
説明
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Forbidden
API error response.
フィールド
タイプ
説明
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
フィールド
タイプ
説明
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Internal Server Error
Errors occurred.
フィールド
タイプ
説明
errors[object]
Structured errors.
detailstring
Error message.
statusstring
Error code.
titlestring
Error title.
{
"errors": [
{
"detail": "Malformed payload",
"status": "400",
"title": "Bad Request"
}
]
}コード例
Create deployment rule returns "OK" response
# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "My deployment rule",
"options": {
"excluded_resources": []
},
"type": "faulty_deployment_detection"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "My deployment rule",
"options": {
"excluded_resources": []
},
"type": "faulty_deployment_detection"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "My deployment rule",
"options": {
"excluded_resources": []
},
"type": "faulty_deployment_detection"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "My deployment rule",
"options": {
"excluded_resources": []
},
"type": "faulty_deployment_detection"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "My deployment rule",
"options": {
"excluded_resources": []
},
"type": "faulty_deployment_detection"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "My deployment rule",
"options": {
"excluded_resources": []
},
"type": "faulty_deployment_detection"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "My deployment rule",
"options": {
"excluded_resources": []
},
"type": "faulty_deployment_detection"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "My deployment rule",
"options": {
"excluded_resources": []
},
"type": "faulty_deployment_detection"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "My deployment rule",
"options": {
"excluded_resources": []
},
"type": "faulty_deployment_detection"
},
"type": "deployment_rule"
}
}
EOFCreate monitor deployment rule with monitor IDs returns "OK" response
# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Specific monitor deployment rule",
"options": {
"monitor_ids": [
{
"id": "7",
"groups": []
}
]
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Specific monitor deployment rule",
"options": {
"monitor_ids": [
{
"id": "7",
"groups": []
}
]
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Specific monitor deployment rule",
"options": {
"monitor_ids": [
{
"id": "7",
"groups": []
}
]
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Specific monitor deployment rule",
"options": {
"monitor_ids": [
{
"id": "7",
"groups": []
}
]
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Specific monitor deployment rule",
"options": {
"monitor_ids": [
{
"id": "7",
"groups": []
}
]
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Specific monitor deployment rule",
"options": {
"monitor_ids": [
{
"id": "7",
"groups": []
}
]
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Specific monitor deployment rule",
"options": {
"monitor_ids": [
{
"id": "7",
"groups": []
}
]
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Specific monitor deployment rule",
"options": {
"monitor_ids": [
{
"id": "7",
"groups": []
}
]
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Specific monitor deployment rule",
"options": {
"monitor_ids": [
{
"id": "7",
"groups": []
}
]
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOFCreate monitor deployment rule with query returns "OK" response
# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Query monitor deployment rule",
"options": {
"query": "service:transaction-backend env:production"
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Query monitor deployment rule",
"options": {
"query": "service:transaction-backend env:production"
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Query monitor deployment rule",
"options": {
"query": "service:transaction-backend env:production"
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Query monitor deployment rule",
"options": {
"query": "service:transaction-backend env:production"
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Query monitor deployment rule",
"options": {
"query": "service:transaction-backend env:production"
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Query monitor deployment rule",
"options": {
"query": "service:transaction-backend env:production"
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Query monitor deployment rule",
"options": {
"query": "service:transaction-backend env:production"
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Query monitor deployment rule",
"options": {
"query": "service:transaction-backend env:production"
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOF# Path parameters
export gate_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/deployment_gates/${gate_id}/rules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"dry_run": false,
"name": "Query monitor deployment rule",
"options": {
"query": "service:transaction-backend env:production"
},
"type": "monitor"
},
"type": "deployment_rule"
}
}
EOFCreate deployment rule returns "OK" response
// Create deployment rule 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() {
// there is a valid "deployment_gate" in the system
DeploymentGateDataID := os.Getenv("DEPLOYMENT_GATE_DATA_ID")
body := datadogV2.CreateDeploymentRuleParams{
Data: &datadogV2.CreateDeploymentRuleParamsData{
Attributes: datadogV2.CreateDeploymentRuleParamsDataAttributes{
DryRun: datadog.PtrBool(false),
Name: "My deployment rule",
Options: datadogV2.DeploymentRulesOptions{
DeploymentRuleOptionsFaultyDeploymentDetection: &datadogV2.DeploymentRuleOptionsFaultyDeploymentDetection{
ExcludedResources: []string{},
}},
Type: "faulty_deployment_detection",
},
Type: datadogV2.DEPLOYMENTRULEDATATYPE_DEPLOYMENT_RULE,
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.CreateDeploymentRule", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewDeploymentGatesApi(apiClient)
resp, r, err := api.CreateDeploymentRule(ctx, DeploymentGateDataID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DeploymentGatesApi.CreateDeploymentRule`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DeploymentGatesApi.CreateDeploymentRule`:\n%s\n", responseContent)
}
Create monitor deployment rule with monitor IDs returns "OK" response
// Create monitor deployment rule with monitor IDs 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() {
// there is a valid "deployment_gate" in the system
DeploymentGateDataID := os.Getenv("DEPLOYMENT_GATE_DATA_ID")
// there is a valid "monitor" in the system
body := datadogV2.CreateDeploymentRuleParams{
Data: &datadogV2.CreateDeploymentRuleParamsData{
Attributes: datadogV2.CreateDeploymentRuleParamsDataAttributes{
DryRun: datadog.PtrBool(false),
Name: "Specific monitor deployment rule",
Options: datadogV2.DeploymentRulesOptions{
DeploymentRuleOptionsMonitorIds: &datadogV2.DeploymentRuleOptionsMonitorIds{
MonitorIds: []datadogV2.DeploymentRuleOptionsMonitorId{
{
Id: "7",
Groups: []string{},
},
},
}},
Type: "monitor",
},
Type: datadogV2.DEPLOYMENTRULEDATATYPE_DEPLOYMENT_RULE,
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.CreateDeploymentRule", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewDeploymentGatesApi(apiClient)
resp, r, err := api.CreateDeploymentRule(ctx, DeploymentGateDataID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DeploymentGatesApi.CreateDeploymentRule`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DeploymentGatesApi.CreateDeploymentRule`:\n%s\n", responseContent)
}
Create monitor deployment rule with query returns "OK" response
// Create monitor deployment rule with query 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() {
// there is a valid "deployment_gate" in the system
DeploymentGateDataID := os.Getenv("DEPLOYMENT_GATE_DATA_ID")
body := datadogV2.CreateDeploymentRuleParams{
Data: &datadogV2.CreateDeploymentRuleParamsData{
Attributes: datadogV2.CreateDeploymentRuleParamsDataAttributes{
DryRun: datadog.PtrBool(false),
Name: "Query monitor deployment rule",
Options: datadogV2.DeploymentRulesOptions{
DeploymentRuleOptionsMonitor: &datadogV2.DeploymentRuleOptionsMonitor{
Query: "service:transaction-backend env:production",
}},
Type: "monitor",
},
Type: datadogV2.DEPLOYMENTRULEDATATYPE_DEPLOYMENT_RULE,
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.CreateDeploymentRule", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewDeploymentGatesApi(apiClient)
resp, r, err := api.CreateDeploymentRule(ctx, DeploymentGateDataID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DeploymentGatesApi.CreateDeploymentRule`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DeploymentGatesApi.CreateDeploymentRule`:\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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"Create deployment rule returns "OK" response
// Create deployment rule 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.CreateDeploymentRuleParams;
import com.datadog.api.client.v2.model.CreateDeploymentRuleParamsData;
import com.datadog.api.client.v2.model.CreateDeploymentRuleParamsDataAttributes;
import com.datadog.api.client.v2.model.DeploymentRuleDataType;
import com.datadog.api.client.v2.model.DeploymentRuleOptionsFaultyDeploymentDetection;
import com.datadog.api.client.v2.model.DeploymentRuleResponse;
import com.datadog.api.client.v2.model.DeploymentRulesOptions;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
defaultClient.setUnstableOperationEnabled("v2.createDeploymentRule", true);
DeploymentGatesApi apiInstance = new DeploymentGatesApi(defaultClient);
// there is a valid "deployment_gate" in the system
String DEPLOYMENT_GATE_DATA_ID = System.getenv("DEPLOYMENT_GATE_DATA_ID");
CreateDeploymentRuleParams body =
new CreateDeploymentRuleParams()
.data(
new CreateDeploymentRuleParamsData()
.attributes(
new CreateDeploymentRuleParamsDataAttributes()
.dryRun(false)
.name("My deployment rule")
.options(
new DeploymentRulesOptions(
new DeploymentRuleOptionsFaultyDeploymentDetection()))
.type("faulty_deployment_detection"))
.type(DeploymentRuleDataType.DEPLOYMENT_RULE));
try {
DeploymentRuleResponse result =
apiInstance.createDeploymentRule(DEPLOYMENT_GATE_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeploymentGatesApi#createDeploymentRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Create monitor deployment rule with monitor IDs returns "OK" response
// Create monitor deployment rule with monitor IDs 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.CreateDeploymentRuleParams;
import com.datadog.api.client.v2.model.CreateDeploymentRuleParamsData;
import com.datadog.api.client.v2.model.CreateDeploymentRuleParamsDataAttributes;
import com.datadog.api.client.v2.model.DeploymentRuleDataType;
import com.datadog.api.client.v2.model.DeploymentRuleOptionsMonitorId;
import com.datadog.api.client.v2.model.DeploymentRuleOptionsMonitorIds;
import com.datadog.api.client.v2.model.DeploymentRuleResponse;
import com.datadog.api.client.v2.model.DeploymentRulesOptions;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
defaultClient.setUnstableOperationEnabled("v2.createDeploymentRule", true);
DeploymentGatesApi apiInstance = new DeploymentGatesApi(defaultClient);
// there is a valid "deployment_gate" in the system
String DEPLOYMENT_GATE_DATA_ID = System.getenv("DEPLOYMENT_GATE_DATA_ID");
// there is a valid "monitor" in the system
Long MONITOR_ID = Long.parseLong(System.getenv("MONITOR_ID"));
CreateDeploymentRuleParams body =
new CreateDeploymentRuleParams()
.data(
new CreateDeploymentRuleParamsData()
.attributes(
new CreateDeploymentRuleParamsDataAttributes()
.dryRun(false)
.name("Specific monitor deployment rule")
.options(
new DeploymentRulesOptions(
new DeploymentRuleOptionsMonitorIds()
.monitorIds(
Collections.singletonList(
new DeploymentRuleOptionsMonitorId().id("7")))))
.type("monitor"))
.type(DeploymentRuleDataType.DEPLOYMENT_RULE));
try {
DeploymentRuleResponse result =
apiInstance.createDeploymentRule(DEPLOYMENT_GATE_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeploymentGatesApi#createDeploymentRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Create monitor deployment rule with query returns "OK" response
// Create monitor deployment rule with query 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.CreateDeploymentRuleParams;
import com.datadog.api.client.v2.model.CreateDeploymentRuleParamsData;
import com.datadog.api.client.v2.model.CreateDeploymentRuleParamsDataAttributes;
import com.datadog.api.client.v2.model.DeploymentRuleDataType;
import com.datadog.api.client.v2.model.DeploymentRuleOptionsMonitor;
import com.datadog.api.client.v2.model.DeploymentRuleResponse;
import com.datadog.api.client.v2.model.DeploymentRulesOptions;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
defaultClient.setUnstableOperationEnabled("v2.createDeploymentRule", true);
DeploymentGatesApi apiInstance = new DeploymentGatesApi(defaultClient);
// there is a valid "deployment_gate" in the system
String DEPLOYMENT_GATE_DATA_ID = System.getenv("DEPLOYMENT_GATE_DATA_ID");
CreateDeploymentRuleParams body =
new CreateDeploymentRuleParams()
.data(
new CreateDeploymentRuleParamsData()
.attributes(
new CreateDeploymentRuleParamsDataAttributes()
.dryRun(false)
.name("Query monitor deployment rule")
.options(
new DeploymentRulesOptions(
new DeploymentRuleOptionsMonitor()
.query("service:transaction-backend env:production")))
.type("monitor"))
.type(DeploymentRuleDataType.DEPLOYMENT_RULE));
try {
DeploymentRuleResponse result =
apiInstance.createDeploymentRule(DEPLOYMENT_GATE_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeploymentGatesApi#createDeploymentRule");
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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"Create deployment rule returns "OK" response
"""
Create deployment rule 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
from datadog_api_client.v2.model.create_deployment_rule_params import CreateDeploymentRuleParams
from datadog_api_client.v2.model.create_deployment_rule_params_data import CreateDeploymentRuleParamsData
from datadog_api_client.v2.model.create_deployment_rule_params_data_attributes import (
CreateDeploymentRuleParamsDataAttributes,
)
from datadog_api_client.v2.model.deployment_rule_data_type import DeploymentRuleDataType
from datadog_api_client.v2.model.deployment_rule_options_faulty_deployment_detection import (
DeploymentRuleOptionsFaultyDeploymentDetection,
)
# there is a valid "deployment_gate" in the system
DEPLOYMENT_GATE_DATA_ID = environ["DEPLOYMENT_GATE_DATA_ID"]
body = CreateDeploymentRuleParams(
data=CreateDeploymentRuleParamsData(
attributes=CreateDeploymentRuleParamsDataAttributes(
dry_run=False,
name="My deployment rule",
options=DeploymentRuleOptionsFaultyDeploymentDetection(
excluded_resources=[],
),
type="faulty_deployment_detection",
),
type=DeploymentRuleDataType.DEPLOYMENT_RULE,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["create_deployment_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = DeploymentGatesApi(api_client)
response = api_instance.create_deployment_rule(gate_id=DEPLOYMENT_GATE_DATA_ID, body=body)
print(response)
Create monitor deployment rule with monitor IDs returns "OK" response
"""
Create monitor deployment rule with monitor IDs 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
from datadog_api_client.v2.model.create_deployment_rule_params import CreateDeploymentRuleParams
from datadog_api_client.v2.model.create_deployment_rule_params_data import CreateDeploymentRuleParamsData
from datadog_api_client.v2.model.create_deployment_rule_params_data_attributes import (
CreateDeploymentRuleParamsDataAttributes,
)
from datadog_api_client.v2.model.deployment_rule_data_type import DeploymentRuleDataType
from datadog_api_client.v2.model.deployment_rule_options_monitor_id import DeploymentRuleOptionsMonitorId
from datadog_api_client.v2.model.deployment_rule_options_monitor_ids import DeploymentRuleOptionsMonitorIds
# there is a valid "deployment_gate" in the system
DEPLOYMENT_GATE_DATA_ID = environ["DEPLOYMENT_GATE_DATA_ID"]
# there is a valid "monitor" in the system
MONITOR_ID = environ["MONITOR_ID"]
body = CreateDeploymentRuleParams(
data=CreateDeploymentRuleParamsData(
attributes=CreateDeploymentRuleParamsDataAttributes(
dry_run=False,
name="Specific monitor deployment rule",
options=DeploymentRuleOptionsMonitorIds(
monitor_ids=[
DeploymentRuleOptionsMonitorId(
id="7",
groups=[],
),
],
),
type="monitor",
),
type=DeploymentRuleDataType.DEPLOYMENT_RULE,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["create_deployment_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = DeploymentGatesApi(api_client)
response = api_instance.create_deployment_rule(gate_id=DEPLOYMENT_GATE_DATA_ID, body=body)
print(response)
Create monitor deployment rule with query returns "OK" response
"""
Create monitor deployment rule with query 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
from datadog_api_client.v2.model.create_deployment_rule_params import CreateDeploymentRuleParams
from datadog_api_client.v2.model.create_deployment_rule_params_data import CreateDeploymentRuleParamsData
from datadog_api_client.v2.model.create_deployment_rule_params_data_attributes import (
CreateDeploymentRuleParamsDataAttributes,
)
from datadog_api_client.v2.model.deployment_rule_data_type import DeploymentRuleDataType
from datadog_api_client.v2.model.deployment_rule_options_monitor import DeploymentRuleOptionsMonitor
# there is a valid "deployment_gate" in the system
DEPLOYMENT_GATE_DATA_ID = environ["DEPLOYMENT_GATE_DATA_ID"]
body = CreateDeploymentRuleParams(
data=CreateDeploymentRuleParamsData(
attributes=CreateDeploymentRuleParamsDataAttributes(
dry_run=False,
name="Query monitor deployment rule",
options=DeploymentRuleOptionsMonitor(
query="service:transaction-backend env:production",
),
type="monitor",
),
type=DeploymentRuleDataType.DEPLOYMENT_RULE,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["create_deployment_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = DeploymentGatesApi(api_client)
response = api_instance.create_deployment_rule(gate_id=DEPLOYMENT_GATE_DATA_ID, 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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"Create deployment rule returns "OK" response
# Create deployment rule returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
config.unstable_operations["v2.create_deployment_rule".to_sym] = true
end
api_instance = DatadogAPIClient::V2::DeploymentGatesAPI.new
# there is a valid "deployment_gate" in the system
DEPLOYMENT_GATE_DATA_ID = ENV["DEPLOYMENT_GATE_DATA_ID"]
body = DatadogAPIClient::V2::CreateDeploymentRuleParams.new({
data: DatadogAPIClient::V2::CreateDeploymentRuleParamsData.new({
attributes: DatadogAPIClient::V2::CreateDeploymentRuleParamsDataAttributes.new({
dry_run: false,
name: "My deployment rule",
options: DatadogAPIClient::V2::DeploymentRuleOptionsFaultyDeploymentDetection.new({
excluded_resources: [],
}),
type: "faulty_deployment_detection",
}),
type: DatadogAPIClient::V2::DeploymentRuleDataType::DEPLOYMENT_RULE,
}),
})
p api_instance.create_deployment_rule(DEPLOYMENT_GATE_DATA_ID, body)
Create monitor deployment rule with monitor IDs returns "OK" response
# Create monitor deployment rule with monitor IDs returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
config.unstable_operations["v2.create_deployment_rule".to_sym] = true
end
api_instance = DatadogAPIClient::V2::DeploymentGatesAPI.new
# there is a valid "deployment_gate" in the system
DEPLOYMENT_GATE_DATA_ID = ENV["DEPLOYMENT_GATE_DATA_ID"]
# there is a valid "monitor" in the system
MONITOR_ID = ENV["MONITOR_ID"]
body = DatadogAPIClient::V2::CreateDeploymentRuleParams.new({
data: DatadogAPIClient::V2::CreateDeploymentRuleParamsData.new({
attributes: DatadogAPIClient::V2::CreateDeploymentRuleParamsDataAttributes.new({
dry_run: false,
name: "Specific monitor deployment rule",
options: DatadogAPIClient::V2::DeploymentRuleOptionsMonitorIds.new({
monitor_ids: [
DatadogAPIClient::V2::DeploymentRuleOptionsMonitorId.new({
id: "7",
groups: [],
}),
],
}),
type: "monitor",
}),
type: DatadogAPIClient::V2::DeploymentRuleDataType::DEPLOYMENT_RULE,
}),
})
p api_instance.create_deployment_rule(DEPLOYMENT_GATE_DATA_ID, body)
Create monitor deployment rule with query returns "OK" response
# Create monitor deployment rule with query returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
config.unstable_operations["v2.create_deployment_rule".to_sym] = true
end
api_instance = DatadogAPIClient::V2::DeploymentGatesAPI.new
# there is a valid "deployment_gate" in the system
DEPLOYMENT_GATE_DATA_ID = ENV["DEPLOYMENT_GATE_DATA_ID"]
body = DatadogAPIClient::V2::CreateDeploymentRuleParams.new({
data: DatadogAPIClient::V2::CreateDeploymentRuleParamsData.new({
attributes: DatadogAPIClient::V2::CreateDeploymentRuleParamsDataAttributes.new({
dry_run: false,
name: "Query monitor deployment rule",
options: DatadogAPIClient::V2::DeploymentRuleOptionsMonitor.new({
query: "service:transaction-backend env:production",
}),
type: "monitor",
}),
type: DatadogAPIClient::V2::DeploymentRuleDataType::DEPLOYMENT_RULE,
}),
})
p api_instance.create_deployment_rule(DEPLOYMENT_GATE_DATA_ID, 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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"Create deployment rule returns "OK" response
// Create deployment rule returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_deployment_gates::DeploymentGatesAPI;
use datadog_api_client::datadogV2::model::CreateDeploymentRuleParams;
use datadog_api_client::datadogV2::model::CreateDeploymentRuleParamsData;
use datadog_api_client::datadogV2::model::CreateDeploymentRuleParamsDataAttributes;
use datadog_api_client::datadogV2::model::DeploymentRuleDataType;
use datadog_api_client::datadogV2::model::DeploymentRuleOptionsFaultyDeploymentDetection;
use datadog_api_client::datadogV2::model::DeploymentRulesOptions;
#[tokio::main]
async fn main() {
// there is a valid "deployment_gate" in the system
let deployment_gate_data_id = std::env::var("DEPLOYMENT_GATE_DATA_ID").unwrap();
let body = CreateDeploymentRuleParams::new().data(CreateDeploymentRuleParamsData::new(
CreateDeploymentRuleParamsDataAttributes::new(
"My deployment rule".to_string(),
DeploymentRulesOptions::DeploymentRuleOptionsFaultyDeploymentDetection(Box::new(
DeploymentRuleOptionsFaultyDeploymentDetection::new().excluded_resources(vec![]),
)),
"faulty_deployment_detection".to_string(),
)
.dry_run(false),
DeploymentRuleDataType::DEPLOYMENT_RULE,
));
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.create_deployment_rule", true);
let api = DeploymentGatesAPI::with_config(configuration);
let resp = api
.create_deployment_rule(deployment_gate_data_id.clone(), body)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Create monitor deployment rule with monitor IDs returns "OK" response
// Create monitor deployment rule with monitor IDs returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_deployment_gates::DeploymentGatesAPI;
use datadog_api_client::datadogV2::model::CreateDeploymentRuleParams;
use datadog_api_client::datadogV2::model::CreateDeploymentRuleParamsData;
use datadog_api_client::datadogV2::model::CreateDeploymentRuleParamsDataAttributes;
use datadog_api_client::datadogV2::model::DeploymentRuleDataType;
use datadog_api_client::datadogV2::model::DeploymentRuleOptionsMonitorId;
use datadog_api_client::datadogV2::model::DeploymentRuleOptionsMonitorIds;
use datadog_api_client::datadogV2::model::DeploymentRulesOptions;
#[tokio::main]
async fn main() {
// there is a valid "deployment_gate" in the system
let deployment_gate_data_id = std::env::var("DEPLOYMENT_GATE_DATA_ID").unwrap();
// there is a valid "monitor" in the system
let body = CreateDeploymentRuleParams::new().data(CreateDeploymentRuleParamsData::new(
CreateDeploymentRuleParamsDataAttributes::new(
"Specific monitor deployment rule".to_string(),
DeploymentRulesOptions::DeploymentRuleOptionsMonitorIds(Box::new(
DeploymentRuleOptionsMonitorIds::new(vec![DeploymentRuleOptionsMonitorId::new(
vec![],
"7".to_string(),
)]),
)),
"monitor".to_string(),
)
.dry_run(false),
DeploymentRuleDataType::DEPLOYMENT_RULE,
));
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.create_deployment_rule", true);
let api = DeploymentGatesAPI::with_config(configuration);
let resp = api
.create_deployment_rule(deployment_gate_data_id.clone(), body)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Create monitor deployment rule with query returns "OK" response
// Create monitor deployment rule with query returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_deployment_gates::DeploymentGatesAPI;
use datadog_api_client::datadogV2::model::CreateDeploymentRuleParams;
use datadog_api_client::datadogV2::model::CreateDeploymentRuleParamsData;
use datadog_api_client::datadogV2::model::CreateDeploymentRuleParamsDataAttributes;
use datadog_api_client::datadogV2::model::DeploymentRuleDataType;
use datadog_api_client::datadogV2::model::DeploymentRuleOptionsMonitor;
use datadog_api_client::datadogV2::model::DeploymentRulesOptions;
#[tokio::main]
async fn main() {
// there is a valid "deployment_gate" in the system
let deployment_gate_data_id = std::env::var("DEPLOYMENT_GATE_DATA_ID").unwrap();
let body = CreateDeploymentRuleParams::new().data(CreateDeploymentRuleParamsData::new(
CreateDeploymentRuleParamsDataAttributes::new(
"Query monitor deployment rule".to_string(),
DeploymentRulesOptions::DeploymentRuleOptionsMonitor(Box::new(
DeploymentRuleOptionsMonitor::new(
"service:transaction-backend env:production".to_string(),
),
)),
"monitor".to_string(),
)
.dry_run(false),
DeploymentRuleDataType::DEPLOYMENT_RULE,
));
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.create_deployment_rule", true);
let api = DeploymentGatesAPI::with_config(configuration);
let resp = api
.create_deployment_rule(deployment_gate_data_id.clone(), 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" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runCreate deployment rule returns "OK" response
/**
* Create deployment rule 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.createDeploymentRule"] = true;
const apiInstance = new v2.DeploymentGatesApi(configuration);
// there is a valid "deployment_gate" in the system
const DEPLOYMENT_GATE_DATA_ID = process.env.DEPLOYMENT_GATE_DATA_ID as string;
const params: v2.DeploymentGatesApiCreateDeploymentRuleRequest = {
body: {
data: {
attributes: {
dryRun: false,
name: "My deployment rule",
options: {
excludedResources: [],
},
type: "faulty_deployment_detection",
},
type: "deployment_rule",
},
},
gateId: DEPLOYMENT_GATE_DATA_ID,
};
apiInstance
.createDeploymentRule(params)
.then((data: v2.DeploymentRuleResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Create monitor deployment rule with monitor IDs returns "OK" response
/**
* Create monitor deployment rule with monitor IDs 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.createDeploymentRule"] = true;
const apiInstance = new v2.DeploymentGatesApi(configuration);
// there is a valid "deployment_gate" in the system
const DEPLOYMENT_GATE_DATA_ID = process.env.DEPLOYMENT_GATE_DATA_ID as string;
// there is a valid "monitor" in the system
const params: v2.DeploymentGatesApiCreateDeploymentRuleRequest = {
body: {
data: {
attributes: {
dryRun: false,
name: "Specific monitor deployment rule",
options: {
monitorIds: [
{
id: "7",
groups: [],
},
],
},
type: "monitor",
},
type: "deployment_rule",
},
},
gateId: DEPLOYMENT_GATE_DATA_ID,
};
apiInstance
.createDeploymentRule(params)
.then((data: v2.DeploymentRuleResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Create monitor deployment rule with query returns "OK" response
/**
* Create monitor deployment rule with query 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.createDeploymentRule"] = true;
const apiInstance = new v2.DeploymentGatesApi(configuration);
// there is a valid "deployment_gate" in the system
const DEPLOYMENT_GATE_DATA_ID = process.env.DEPLOYMENT_GATE_DATA_ID as string;
const params: v2.DeploymentGatesApiCreateDeploymentRuleRequest = {
body: {
data: {
attributes: {
dryRun: false,
name: "Query monitor deployment rule",
options: {
query: "service:transaction-backend env:production",
},
type: "monitor",
},
type: "deployment_rule",
},
},
gateId: DEPLOYMENT_GATE_DATA_ID,
};
apiInstance
.createDeploymentRule(params)
.then((data: v2.DeploymentRuleResponse) => {
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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"