datadog-api-collection-schema.json•6.61 MB
{
"info": {
"_postman_id": "809b13c1-4ada-46c1-af65-ab276c434068",
"name": "Datadog API Collection",
"description": "**Note**: The Datadog API Collection features a streamlined process for configuring authentication through [Collection variables](https://learning.postman.com/docs/sending-requests/variables/variables/#defining-collection-variables). This eliminates the previous need to configure and select the Datadog Authentication environment. To access the legacy Datadog API Collection and authentication process, see the [Legacy Datadog API Collection](https://www.postman.com/datadog/workspace/datadog-s-public-workspace/collection/31135111-690dad6a-a926-4eb5-a826-bd7140530209).\n\nIf you're new to Postman, see the [Navigating Postman](https://learning.postman.com/docs/getting-started/basics/navigating-postman/) page to learn about the tools, views, and controls that help you manage your API projects.\n\nDatadog recommends using the **Validate API key** request to ensure that you’ve correctly configured the collection variables with your Datadog credentials.\n\nIf you haven’t already, configure the Datadog API Collection’s `api_key` and `application_key` values with your valid [Datadog API and application key](https://docs.datadoghq.com/account_management/api-app-keys/) values, respectively:\n\n<img src=\"https://lh7-us.googleusercontent.com/YDIVdEB5ZmXJXMgTka3R9rQ4rBm_LHceARzLzQAT17ME88tPHIp5-3XpmRWMNqPYvRSh9ZPJN0mJIGmPTRi8bnpbkWW1kGMx270P8kg3fmSAHQqkucg-L2xd_RR98CMASng-H9m_hI3RBkI2ozVjErM\" alt=\"The%20collection%20variables%20with%20the%20api_key%20and%20application_key%20variables%20configured\">\n\nWith the collection variables configured, send the [Validate API key](https://www.postman.com/datadog/workspace/datadog-s-public-workspace/request/20651290-e4c2d752-526c-4686-a5eb-5a35e1321236) request to get your first 200 response code. Now you’re ready to explore the Datadog API!\n\nFor the official documentation, see the [API reference](https://docs.datadoghq.com/api/latest/).\n\nThis API collection was last updated on September 5, 2025.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "12585580",
"_collection_link": "https://www.postman.com/datadog/datadog-s-public-workspace/collection/yp38wxl/datadog-api-collection?action=share&source=collection_link&creator=12585580"
},
"item": [
{
"name": "Get started",
"item": [
{
"name": "Step 1: Fork the collection",
"item": [],
"description": "1. [Fork this collection](https://www.postman.com/datadog/workspace/datadog-s-public-workspace/collection/20651290-809b13c1-4ada-46c1-af65-ab276c434068/fork).\n2. Optionally, update the default label.\n3. Confirm that **My Workspace** is selected in the **Workspace** dropdown.\n \n4. Click **Fork Collection**."
},
{
"name": "Step 2: Configure authentication",
"item": [],
"description": "1. Retrieve or create your valid API and application key values from the [Organization Settings](https://app.datadoghq.com/organization-settings/) page in Datadog, or through the [Datadog API](https://docs.datadoghq.com/api/latest/key-management/).\n2. Select the **Datadog API Collection** in Postman.\n3. Click the **Variables** tab.\n4. Enter your API and application key values in the **Current value** field of the `api_key` and `application_key` variables, respectively:\n \n\n<img src=\"https://lh7-us.googleusercontent.com/UKyhmQE2XiYJ01KieWhuX0Tkr-FcTWaqW4lnmIJr_LQ7bm2yFTfuqcrf8mx00q_RZgYXhPbl98S-tRDWVrpE65CRrP9Fv1m_jvCi6Sr0aQWjX_3bGcw4bhsOFprNEADqyJZ-gQ9Dr2RE1MsoTxhmj1Y\">\n\n5\\. Click **Save**."
}
],
"description": "This folder provides instructions for the initial setup of your Datadog Postman environment."
},
{
"name": "Action Connection",
"item": [
{
"name": "Get an existing Action Connection",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Get an existing Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key)."
},
"response": [
{
"name": "Successfully get Action Connection",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"name\": \"My AWS Connection\",\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"account_id\": \"111222333444\",\n \"role\": \"my-role\",\n \"external_id\": \"33a1011635c44b38a064cf14e82e1d8f\",\n \"principal_id\": \"123456789012\"\n }\n }\n },\n \"id\": \"mollit aliquip esse eu adipisicing\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too Many Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
},
{
"name": "Create a new Action Connection",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"name\": \"My AWS Connection\",\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"account_id\": \"111222333444\",\n \"role\": \"my-role\",\n \"external_id\": \"33a1011635c44b38a064cf14e82e1d8f\",\n \"principal_id\": \"123456789012\"\n }\n }\n },\n \"id\": \"et dolore\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections"
]
},
"description": "Create a new Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key)."
},
"response": [
{
"name": "Successfully created Action Connection",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"name\": \"My AWS Connection\",\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"account_id\": \"111222333444\",\n \"role\": \"my-role\",\n \"external_id\": \"33a1011635c44b38a064cf14e82e1d8f\",\n \"principal_id\": \"123456789012\"\n }\n }\n },\n \"id\": \"et dolore\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"name\": \"My AWS Connection\",\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"account_id\": \"111222333444\",\n \"role\": \"my-role\",\n \"external_id\": \"33a1011635c44b38a064cf14e82e1d8f\",\n \"principal_id\": \"123456789012\"\n }\n }\n },\n \"id\": \"culpa deserunt minim\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"name\": \"My AWS Connection\",\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"account_id\": \"111222333444\",\n \"role\": \"my-role\",\n \"external_id\": \"33a1011635c44b38a064cf14e82e1d8f\",\n \"principal_id\": \"123456789012\"\n }\n }\n },\n \"id\": \"et dolore\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"name\": \"My AWS Connection\",\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"account_id\": \"111222333444\",\n \"role\": \"my-role\",\n \"external_id\": \"33a1011635c44b38a064cf14e82e1d8f\",\n \"principal_id\": \"123456789012\"\n }\n }\n },\n \"id\": \"et dolore\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too Many Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"name\": \"My AWS Connection\",\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"account_id\": \"111222333444\",\n \"role\": \"my-role\",\n \"external_id\": \"33a1011635c44b38a064cf14e82e1d8f\",\n \"principal_id\": \"123456789012\"\n }\n }\n },\n \"id\": \"et dolore\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
},
{
"name": "Update an existing Action Connection",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"account_id\": \"111222333444\",\n \"generate_new_external_id\": false,\n \"role\": \"my-role\"\n }\n },\n \"name\": \"My AWS Connection\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Update an existing Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key)."
},
"response": [
{
"name": "Successfully updated Action Connection",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"account_id\": \"111222333444\",\n \"generate_new_external_id\": false,\n \"role\": \"my-role\"\n }\n },\n \"name\": \"My AWS Connection\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"name\": \"My AWS Connection\",\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"account_id\": \"111222333444\",\n \"role\": \"my-role\",\n \"external_id\": \"33a1011635c44b38a064cf14e82e1d8f\",\n \"principal_id\": \"123456789012\"\n }\n }\n },\n \"id\": \"commodo labore Ut\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"account_id\": \"111222333444\",\n \"generate_new_external_id\": false,\n \"role\": \"my-role\"\n }\n },\n \"name\": \"My AWS Connection\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"account_id\": \"111222333444\",\n \"generate_new_external_id\": false,\n \"role\": \"my-role\"\n }\n },\n \"name\": \"My AWS Connection\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"account_id\": \"111222333444\",\n \"generate_new_external_id\": false,\n \"role\": \"my-role\"\n }\n },\n \"name\": \"My AWS Connection\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too Many Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"account_id\": \"111222333444\",\n \"generate_new_external_id\": false,\n \"role\": \"my-role\"\n }\n },\n \"name\": \"My AWS Connection\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
},
{
"name": "Delete an existing Action Connection",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Delete an existing Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access)."
},
"response": [
{
"name": "The resource was deleted successfully.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too Many Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/connections/:connection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"connections",
":connection_id"
],
"variable": [
{
"key": "connection_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
},
{
"name": "Register a new App Key",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Register a new App Key"
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"app_key_registration\",\n \"id\": \"46f7232c-96c3-5381-cbb9-1de873221679\"\n }\n}"
},
{
"name": "Bad request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
},
{
"name": "List App Key Registrations",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations?page[size]=36993837&page[number]=36993837",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations"
],
"query": [
{
"key": "page[size]",
"value": "36993837",
"description": "The number of App Key Registrations to return per page."
},
{
"key": "page[number]",
"value": "36993837",
"description": "The page number to return."
}
]
},
"description": "List App Key Registrations"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations?page[size]=36993837&page[number]=36993837",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations"
],
"query": [
{
"key": "page[size]",
"value": "36993837",
"description": "The number of App Key Registrations to return per page."
},
{
"key": "page[number]",
"value": "36993837",
"description": "The page number to return."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"type\": \"app_key_registration\",\n \"id\": \"urn:uuid:f484f28d-7020-e065-0699-e4ac35e1fa64\"\n },\n {\n \"type\": \"app_key_registration\",\n \"id\": \"df52aee4-a476-d6fa-df95-1deee9e5e127\"\n }\n ],\n \"meta\": {\n \"total\": 1,\n \"total_filtered\": 1\n }\n}"
},
{
"name": "Bad request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations?page[size]=36993837&page[number]=36993837",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations"
],
"query": [
{
"key": "page[size]",
"value": "36993837",
"description": "The number of App Key Registrations to return per page."
},
{
"key": "page[number]",
"value": "36993837",
"description": "The page number to return."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations?page[size]=36993837&page[number]=36993837",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations"
],
"query": [
{
"key": "page[size]",
"value": "36993837",
"description": "The number of App Key Registrations to return per page."
},
{
"key": "page[number]",
"value": "36993837",
"description": "The page number to return."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations?page[size]=36993837&page[number]=36993837",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations"
],
"query": [
{
"key": "page[size]",
"value": "36993837",
"description": "The number of App Key Registrations to return per page."
},
{
"key": "page[number]",
"value": "36993837",
"description": "The page number to return."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
},
{
"name": "Unregister an App Key",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Unregister an App Key"
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
},
{
"name": "Get an existing App Key Registration",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Get an existing App Key Registration"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"app_key_registration\",\n \"id\": \"2ddf4b8d-9f45-f784-0474-c488fa15571f\"\n }\n}"
},
{
"name": "Bad request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/actions/app_key_registrations/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"actions",
"app_key_registrations",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
}
],
"description": "Action connections extend your installed integrations and allow you to take action in your third-party systems\n(e.g. AWS, GitLab, and Statuspage) with Datadog’s Workflow Automation and App Builder products.\n\nDatadog’s Integrations automatically provide authentication for Slack, Microsoft Teams, PagerDuty, Opsgenie,\nJIRA, GitHub, and Statuspage. You do not need additional connections in order to access these tools within\nWorkflow Automation and App Builder.\n\nWe offer granular access control for editing and resolving connections.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Agentless Scanning",
"item": [
{
"name": "List AWS Scan Options",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws"
]
},
"description": "Fetches the scan options configured for AWS accounts."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n },\n \"id\": \"184366314700\",\n \"type\": \"aws_scan_options\"\n },\n {\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n },\n \"id\": \"184366314700\",\n \"type\": \"aws_scan_options\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get AWS scan options",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "123456789012"
}
]
},
"description": "Fetches the Agentless scan options for an activated account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n },\n \"id\": \"184366314700\",\n \"type\": \"aws_scan_options\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Post AWS Scan Options",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"123456789012\",\n \"type\": \"aws_scan_options\",\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws"
]
},
"description": "Activate Agentless scan options for an AWS account."
},
"response": [
{
"name": "Agentless scan options enabled successfully.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"123456789012\",\n \"type\": \"aws_scan_options\",\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n },\n \"id\": \"184366314700\",\n \"type\": \"aws_scan_options\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"123456789012\",\n \"type\": \"aws_scan_options\",\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"123456789012\",\n \"type\": \"aws_scan_options\",\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"123456789012\",\n \"type\": \"aws_scan_options\",\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"123456789012\",\n \"type\": \"aws_scan_options\",\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Patch AWS Scan Options",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"123456789012\",\n \"type\": \"aws_scan_options\",\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "123456789012"
}
]
},
"description": "Update the Agentless scan options for an activated account."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"123456789012\",\n \"type\": \"aws_scan_options\",\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"123456789012\",\n \"type\": \"aws_scan_options\",\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"123456789012\",\n \"type\": \"aws_scan_options\",\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"123456789012\",\n \"type\": \"aws_scan_options\",\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"123456789012\",\n \"type\": \"aws_scan_options\",\n \"attributes\": {\n \"lambda\": true,\n \"sensitive_data\": false,\n \"vuln_containers_os\": true,\n \"vuln_host_os\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete AWS Scan Options",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "123456789012"
}
]
},
"description": "Delete Agentless scan options for an AWS account."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/accounts/aws/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"accounts",
"aws",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get AWS On Demand tasks",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/ondemand/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"ondemand",
"aws"
]
},
"description": "Fetches the most recent 1000 AWS on demand tasks."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/ondemand/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"ondemand",
"aws"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"arn\": \"arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba\",\n \"assigned_at\": \"2025-02-11T18:25:04.550564Z\",\n \"created_at\": \"2025-02-11T18:13:24.576915Z\",\n \"status\": \"QUEUED\"\n },\n \"id\": \"6d09294c-9ad9-42fd-a759-a0c1599b4828\",\n \"type\": \"aws_resource\"\n },\n {\n \"attributes\": {\n \"arn\": \"arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba\",\n \"assigned_at\": \"2025-02-11T18:25:04.550564Z\",\n \"created_at\": \"2025-02-11T18:13:24.576915Z\",\n \"status\": \"QUEUED\"\n },\n \"id\": \"6d09294c-9ad9-42fd-a759-a0c1599b4828\",\n \"type\": \"aws_resource\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/ondemand/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"ondemand",
"aws"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/ondemand/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"ondemand",
"aws"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get AWS On Demand task by id",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/ondemand/aws/:task_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"ondemand",
"aws",
":task_id"
],
"variable": [
{
"key": "task_id",
"value": "6d09294c-9ad9-42fd-a759-a0c1599b4828"
}
]
},
"description": "Fetch the data of a specific on demand task."
},
"response": [
{
"name": "OK.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/ondemand/aws/:task_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"ondemand",
"aws",
":task_id"
],
"variable": [
{
"key": "task_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"arn\": \"arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba\",\n \"assigned_at\": \"2025-02-11T18:25:04.550564Z\",\n \"created_at\": \"2025-02-11T18:13:24.576915Z\",\n \"status\": \"QUEUED\"\n },\n \"id\": \"6d09294c-9ad9-42fd-a759-a0c1599b4828\",\n \"type\": \"aws_resource\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/ondemand/aws/:task_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"ondemand",
"aws",
":task_id"
],
"variable": [
{
"key": "task_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/ondemand/aws/:task_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"ondemand",
"aws",
":task_id"
],
"variable": [
{
"key": "task_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/ondemand/aws/:task_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"ondemand",
"aws",
":task_id"
],
"variable": [
{
"key": "task_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/ondemand/aws/:task_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"ondemand",
"aws",
":task_id"
],
"variable": [
{
"key": "task_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Post an AWS on demand task",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"aws_resource\",\n \"attributes\": {\n \"arn\": \"arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/ondemand/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"ondemand",
"aws"
]
},
"description": "Trigger the scan of an AWS resource with a high priority. Agentless scanning must be activated for the AWS account containing the resource to scan."
},
"response": [
{
"name": "AWS on demand task created successfully.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"aws_resource\",\n \"attributes\": {\n \"arn\": \"arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/ondemand/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"ondemand",
"aws"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"arn\": \"arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba\",\n \"assigned_at\": \"2025-02-11T18:25:04.550564Z\",\n \"created_at\": \"2025-02-11T18:13:24.576915Z\",\n \"status\": \"QUEUED\"\n },\n \"id\": \"6d09294c-9ad9-42fd-a759-a0c1599b4828\",\n \"type\": \"aws_resource\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"aws_resource\",\n \"attributes\": {\n \"arn\": \"arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/ondemand/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"ondemand",
"aws"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"aws_resource\",\n \"attributes\": {\n \"arn\": \"arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/ondemand/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"ondemand",
"aws"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"aws_resource\",\n \"attributes\": {\n \"arn\": \"arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/agentless_scanning/ondemand/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"agentless_scanning",
"ondemand",
"aws"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Datadog Agentless Scanning provides visibility into risks and vulnerabilities\nwithin your hosts, running containers, and serverless functions—all without\nrequiring teams to install Agents on every host or where Agents cannot be installed.\nAgentless offers also Sensitive Data Scanning capabilities on your storage.\nGo to https://www.datadoghq.com/blog/agentless-scanning/ to learn more.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "APM Retention Filters",
"item": [
{
"name": "List all APM retention filters",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
},
"description": "Get the list of APM retention filters."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": \"7RBOb7dLSYWI01yc3pIH8w\",\n \"type\": \"apm_retention_filter\",\n \"attributes\": {\n \"created_at\": -23800587,\n \"created_by\": \"consequat non laboris commodo\",\n \"editable\": true,\n \"enabled\": true,\n \"execution_order\": -8929860,\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"filter_type\": \"spans-sampling-processor\",\n \"modified_at\": 57250191,\n \"modified_by\": \"in ex nisi dolore\",\n \"name\": \"my retention filter\",\n \"rate\": 1\n }\n },\n {\n \"id\": \"7RBOb7dLSYWI01yc3pIH8w\",\n \"type\": \"apm_retention_filter\",\n \"attributes\": {\n \"created_at\": 5772941,\n \"created_by\": \"consequat\",\n \"editable\": true,\n \"enabled\": true,\n \"execution_order\": 8243671,\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"filter_type\": \"spans-sampling-processor\",\n \"modified_at\": -86739935,\n \"modified_by\": \"anim ullamco Excepteur aliquip\",\n \"name\": \"my retention filter\",\n \"rate\": 1\n }\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a retention filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my retention filter\",\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"enabled\": true,\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": 1\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
},
"description": "Create a retention filter to index spans in your organization.\nReturns the retention filter definition when the request is successful."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my retention filter\",\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"enabled\": true,\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": 1\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"7RBOb7dLSYWI01yc3pIH8w\",\n \"type\": \"apm_retention_filter\",\n \"attributes\": {\n \"created_at\": -50257320,\n \"created_by\": \"amet sint\",\n \"editable\": true,\n \"enabled\": true,\n \"execution_order\": -85582523,\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"filter_type\": \"spans-sampling-processor\",\n \"modified_at\": 52601432,\n \"modified_by\": \"consequat culpa fugiat eu\",\n \"name\": \"my retention filter\",\n \"rate\": 1\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my retention filter\",\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"enabled\": true,\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": 1\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my retention filter\",\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"enabled\": true,\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": 1\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my retention filter\",\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"enabled\": true,\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": 1\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my retention filter\",\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"enabled\": true,\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": 1\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a given APM retention filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id",
"value": "pariatur consequat"
}
]
},
"description": "Get an APM retention filter."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"7RBOb7dLSYWI01yc3pIH8w\",\n \"type\": \"apm_retention_filter\",\n \"attributes\": {\n \"created_at\": -50257320,\n \"created_by\": \"amet sint\",\n \"editable\": true,\n \"enabled\": true,\n \"execution_order\": -85582523,\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"filter_type\": \"spans-sampling-processor\",\n \"modified_at\": 52601432,\n \"modified_by\": \"consequat culpa fugiat eu\",\n \"name\": \"my retention filter\",\n \"rate\": 1\n }\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a retention filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"retention-filter-id\",\n \"attributes\": {\n \"name\": \"my retention filter\",\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"enabled\": true,\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": 1\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id",
"value": "pariatur consequat"
}
]
},
"description": "Update a retention filter from your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"retention-filter-id\",\n \"attributes\": {\n \"name\": \"my retention filter\",\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"enabled\": true,\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": 1\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"7RBOb7dLSYWI01yc3pIH8w\",\n \"type\": \"apm_retention_filter\",\n \"attributes\": {\n \"created_at\": -50257320,\n \"created_by\": \"amet sint\",\n \"editable\": true,\n \"enabled\": true,\n \"execution_order\": -85582523,\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"filter_type\": \"spans-sampling-processor\",\n \"modified_at\": 52601432,\n \"modified_by\": \"consequat culpa fugiat eu\",\n \"name\": \"my retention filter\",\n \"rate\": 1\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"retention-filter-id\",\n \"attributes\": {\n \"name\": \"my retention filter\",\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"enabled\": true,\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": 1\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"retention-filter-id\",\n \"attributes\": {\n \"name\": \"my retention filter\",\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"enabled\": true,\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": 1\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"retention-filter-id\",\n \"attributes\": {\n \"name\": \"my retention filter\",\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"enabled\": true,\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": 1\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"retention-filter-id\",\n \"attributes\": {\n \"name\": \"my retention filter\",\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"enabled\": true,\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": 1\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a retention filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete a specific retention filter from your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Re-order retention filters",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"7RBOb7dLSYWI01yc3pIH8w\",\n \"type\": \"apm_retention_filter\"\n },\n {\n \"id\": \"7RBOb7dLSYWI01yc3pIH8w\",\n \"type\": \"apm_retention_filter\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters-execution-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters-execution-order"
]
},
"description": "Re-order the execution order of retention filters."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"7RBOb7dLSYWI01yc3pIH8w\",\n \"type\": \"apm_retention_filter\"\n },\n {\n \"id\": \"7RBOb7dLSYWI01yc3pIH8w\",\n \"type\": \"apm_retention_filter\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters-execution-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters-execution-order"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"7RBOb7dLSYWI01yc3pIH8w\",\n \"type\": \"apm_retention_filter\"\n },\n {\n \"id\": \"7RBOb7dLSYWI01yc3pIH8w\",\n \"type\": \"apm_retention_filter\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters-execution-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters-execution-order"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"7RBOb7dLSYWI01yc3pIH8w\",\n \"type\": \"apm_retention_filter\"\n },\n {\n \"id\": \"7RBOb7dLSYWI01yc3pIH8w\",\n \"type\": \"apm_retention_filter\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters-execution-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters-execution-order"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"7RBOb7dLSYWI01yc3pIH8w\",\n \"type\": \"apm_retention_filter\"\n },\n {\n \"id\": \"7RBOb7dLSYWI01yc3pIH8w\",\n \"type\": \"apm_retention_filter\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters-execution-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters-execution-order"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters) for your organization. You need an API and application key with Admin rights to interact with this endpoint. See [retention filters](https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/#retention-filters) on the Trace Retention page for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "App Builder",
"item": [
{
"name": "List Apps",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps?limit=-55544623&page=-55544623&filter[user_name]=proident dolor&filter[user_uuid]=65bb1f25-52e1-4510-9f8d-22d1516ed693&filter[name]=proident dolor&filter[query]=proident dolor&filter[deployed]=true&filter[tags]=proident dolor&filter[favorite]=true&filter[self_service]=true&sort=-created_at,-created_at",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
],
"query": [
{
"key": "limit",
"value": "-55544623",
"description": "The number of apps to return per page."
},
{
"key": "page",
"value": "-55544623",
"description": "The page number to return."
},
{
"key": "filter[user_name]",
"value": "proident dolor",
"description": "Filter apps by the app creator. Usually the user's email."
},
{
"key": "filter[user_uuid]",
"value": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
"description": "Filter apps by the app creator's UUID."
},
{
"key": "filter[name]",
"value": "proident dolor",
"description": "Filter by app name."
},
{
"key": "filter[query]",
"value": "proident dolor",
"description": "Filter apps by the app name or the app creator."
},
{
"key": "filter[deployed]",
"value": "true",
"description": "Filter apps by whether they are published."
},
{
"key": "filter[tags]",
"value": "proident dolor",
"description": "Filter apps by tags."
},
{
"key": "filter[favorite]",
"value": "true",
"description": "Filter apps by whether you have added them to your favorites."
},
{
"key": "filter[self_service]",
"value": "true",
"description": "Filter apps by whether they are enabled for self-service."
},
{
"key": "sort",
"value": "-created_at,-created_at",
"description": "The fields and direction to sort apps by."
}
]
},
"description": "List all apps, with optional filters and sorting. This endpoint is paginated. Only basic app information such as the app ID, name, and description is returned by this endpoint."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps?limit=-55544623&page=-55544623&filter[user_name]=proident dolor&filter[user_uuid]=65bb1f25-52e1-4510-9f8d-22d1516ed693&filter[name]=proident dolor&filter[query]=proident dolor&filter[deployed]=true&filter[tags]=proident dolor&filter[favorite]=true&filter[self_service]=true&sort=-created_at,-created_at",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
],
"query": [
{
"key": "limit",
"value": "-55544623",
"description": "The number of apps to return per page."
},
{
"key": "page",
"value": "-55544623",
"description": "The page number to return."
},
{
"key": "filter[user_name]",
"value": "proident dolor",
"description": "Filter apps by the app creator. Usually the user's email."
},
{
"key": "filter[user_uuid]",
"value": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
"description": "Filter apps by the app creator's UUID."
},
{
"key": "filter[name]",
"value": "proident dolor",
"description": "Filter by app name."
},
{
"key": "filter[query]",
"value": "proident dolor",
"description": "Filter apps by the app name or the app creator."
},
{
"key": "filter[deployed]",
"value": "true",
"description": "Filter apps by whether they are published."
},
{
"key": "filter[tags]",
"value": "proident dolor",
"description": "Filter apps by tags."
},
{
"key": "filter[favorite]",
"value": "true",
"description": "Filter apps by whether you have added them to your favorites."
},
{
"key": "filter[self_service]",
"value": "true",
"description": "Filter apps by whether they are enabled for self-service."
},
{
"key": "sort",
"value": "-created_at,-created_at",
"description": "The fields and direction to sort apps by."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\",\n \"type\": \"appDefinitions\",\n \"attributes\": {\n \"description\": \"dolore est\",\n \"favorite\": true,\n \"name\": \"nis\",\n \"selfService\": false,\n \"tags\": [\n \"service:webshop-backend\",\n \"team:webshop\"\n ]\n },\n \"meta\": {\n \"created_at\": \"1964-03-30T18:20:18.549Z\",\n \"deleted_at\": \"2020-01-25T05:19:05.921Z\",\n \"org_id\": -25267525,\n \"updated_at\": \"1952-08-12T14:24:52.307Z\",\n \"updated_since_deployment\": true,\n \"user_id\": -4340672,\n \"user_name\": \"commodo ut magna dolore\",\n \"user_uuid\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\",\n \"version\": 25290504\n },\n \"relationships\": {\n \"deployment\": {\n \"data\": {\n \"id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\",\n \"type\": \"deployment\"\n },\n \"meta\": {\n \"created_at\": \"1998-04-09T17:21:48.976Z\",\n \"user_id\": -82854776,\n \"user_name\": \"id reprehenderit labore dolore\",\n \"user_uuid\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\"\n }\n }\n }\n },\n {\n \"id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\",\n \"type\": \"appDefinitions\",\n \"attributes\": {\n \"description\": \"nulla nisi consectetur aliquip\",\n \"favorite\": false,\n \"name\": \"voluptate quis deserunt qui eiu\",\n \"selfService\": false,\n \"tags\": [\n \"service:webshop-backend\",\n \"team:webshop\"\n ]\n },\n \"meta\": {\n \"created_at\": \"2017-10-02T02:59:59.002Z\",\n \"deleted_at\": \"1989-02-02T00:53:33.779Z\",\n \"org_id\": -5750560,\n \"updated_at\": \"1965-02-04T02:41:50.332Z\",\n \"updated_since_deployment\": false,\n \"user_id\": 62317400,\n \"user_name\": \"ullamco laboris\",\n \"user_uuid\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\",\n \"version\": 25223416\n },\n \"relationships\": {\n \"deployment\": {\n \"data\": {\n \"id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\",\n \"type\": \"deployment\"\n },\n \"meta\": {\n \"created_at\": \"2003-11-08T18:50:05.578Z\",\n \"user_id\": -66956419,\n \"user_name\": \"consequat\",\n \"user_uuid\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\"\n }\n }\n }\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"app_version_id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\"\n },\n \"id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\",\n \"meta\": {\n \"created_at\": \"1985-04-23T18:47:22.696Z\",\n \"user_id\": 20105220,\n \"user_name\": \"in et\",\n \"user_uuid\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\"\n },\n \"type\": \"deployment\"\n },\n {\n \"attributes\": {\n \"app_version_id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\"\n },\n \"id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\",\n \"meta\": {\n \"created_at\": \"2007-08-18T11:40:28.186Z\",\n \"user_id\": -28869705,\n \"user_name\": \"esse elit\",\n \"user_uuid\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\"\n },\n \"type\": \"deployment\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"totalCount\": -31112260,\n \"totalFilteredCount\": 27229263\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps?limit=-55544623&page=-55544623&filter[user_name]=proident dolor&filter[user_uuid]=65bb1f25-52e1-4510-9f8d-22d1516ed693&filter[name]=proident dolor&filter[query]=proident dolor&filter[deployed]=true&filter[tags]=proident dolor&filter[favorite]=true&filter[self_service]=true&sort=-created_at,-created_at",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
],
"query": [
{
"key": "limit",
"value": "-55544623",
"description": "The number of apps to return per page."
},
{
"key": "page",
"value": "-55544623",
"description": "The page number to return."
},
{
"key": "filter[user_name]",
"value": "proident dolor",
"description": "Filter apps by the app creator. Usually the user's email."
},
{
"key": "filter[user_uuid]",
"value": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
"description": "Filter apps by the app creator's UUID."
},
{
"key": "filter[name]",
"value": "proident dolor",
"description": "Filter by app name."
},
{
"key": "filter[query]",
"value": "proident dolor",
"description": "Filter apps by the app name or the app creator."
},
{
"key": "filter[deployed]",
"value": "true",
"description": "Filter apps by whether they are published."
},
{
"key": "filter[tags]",
"value": "proident dolor",
"description": "Filter apps by tags."
},
{
"key": "filter[favorite]",
"value": "true",
"description": "Filter apps by whether you have added them to your favorites."
},
{
"key": "filter[self_service]",
"value": "true",
"description": "Filter apps by whether they are enabled for self-service."
},
{
"key": "sort",
"value": "-created_at,-created_at",
"description": "The fields and direction to sort apps by."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps?limit=-55544623&page=-55544623&filter[user_name]=proident dolor&filter[user_uuid]=65bb1f25-52e1-4510-9f8d-22d1516ed693&filter[name]=proident dolor&filter[query]=proident dolor&filter[deployed]=true&filter[tags]=proident dolor&filter[favorite]=true&filter[self_service]=true&sort=-created_at,-created_at",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
],
"query": [
{
"key": "limit",
"value": "-55544623",
"description": "The number of apps to return per page."
},
{
"key": "page",
"value": "-55544623",
"description": "The page number to return."
},
{
"key": "filter[user_name]",
"value": "proident dolor",
"description": "Filter apps by the app creator. Usually the user's email."
},
{
"key": "filter[user_uuid]",
"value": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
"description": "Filter apps by the app creator's UUID."
},
{
"key": "filter[name]",
"value": "proident dolor",
"description": "Filter by app name."
},
{
"key": "filter[query]",
"value": "proident dolor",
"description": "Filter apps by the app name or the app creator."
},
{
"key": "filter[deployed]",
"value": "true",
"description": "Filter apps by whether they are published."
},
{
"key": "filter[tags]",
"value": "proident dolor",
"description": "Filter apps by tags."
},
{
"key": "filter[favorite]",
"value": "true",
"description": "Filter apps by whether you have added them to your favorites."
},
{
"key": "filter[self_service]",
"value": "true",
"description": "Filter apps by whether they are enabled for self-service."
},
{
"key": "sort",
"value": "-created_at,-created_at",
"description": "The fields and direction to sort apps by."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps?limit=-55544623&page=-55544623&filter[user_name]=proident dolor&filter[user_uuid]=65bb1f25-52e1-4510-9f8d-22d1516ed693&filter[name]=proident dolor&filter[query]=proident dolor&filter[deployed]=true&filter[tags]=proident dolor&filter[favorite]=true&filter[self_service]=true&sort=-created_at,-created_at",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
],
"query": [
{
"key": "limit",
"value": "-55544623",
"description": "The number of apps to return per page."
},
{
"key": "page",
"value": "-55544623",
"description": "The page number to return."
},
{
"key": "filter[user_name]",
"value": "proident dolor",
"description": "Filter apps by the app creator. Usually the user's email."
},
{
"key": "filter[user_uuid]",
"value": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
"description": "Filter apps by the app creator's UUID."
},
{
"key": "filter[name]",
"value": "proident dolor",
"description": "Filter by app name."
},
{
"key": "filter[query]",
"value": "proident dolor",
"description": "Filter apps by the app name or the app creator."
},
{
"key": "filter[deployed]",
"value": "true",
"description": "Filter apps by whether they are published."
},
{
"key": "filter[tags]",
"value": "proident dolor",
"description": "Filter apps by tags."
},
{
"key": "filter[favorite]",
"value": "true",
"description": "Filter apps by whether you have added them to your favorites."
},
{
"key": "filter[self_service]",
"value": "true",
"description": "Filter apps by whether they are enabled for self-service."
},
{
"key": "sort",
"value": "-created_at,-created_at",
"description": "The fields and direction to sort apps by."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create App",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"components\": [\n {\n \"events\": [],\n \"name\": \"grid0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"gridCell0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"calloutValue0\",\n \"properties\": {\n \"isDisabled\": false,\n \"isLoading\": false,\n \"isVisible\": true,\n \"label\": \"CPU Usage\",\n \"size\": \"sm\",\n \"style\": \"vivid_yellow\",\n \"unit\": \"kB\",\n \"value\": \"42\"\n },\n \"type\": \"calloutValue\"\n }\n ],\n \"isVisible\": \"true\",\n \"layout\": {\n \"default\": {\n \"height\": 8,\n \"width\": 2,\n \"x\": 0,\n \"y\": 0\n }\n }\n },\n \"type\": \"gridCell\"\n }\n ]\n },\n \"type\": \"grid\"\n }\n ],\n \"description\": \"This is a simple example app\",\n \"name\": \"Example App\",\n \"queries\": [],\n \"rootInstanceName\": \"grid0\"\n },\n \"type\": \"appDefinitions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
]
},
"description": "Create a new app, returning the app ID."
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"components\": [\n {\n \"events\": [],\n \"name\": \"grid0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"gridCell0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"calloutValue0\",\n \"properties\": {\n \"isDisabled\": false,\n \"isLoading\": false,\n \"isVisible\": true,\n \"label\": \"CPU Usage\",\n \"size\": \"sm\",\n \"style\": \"vivid_yellow\",\n \"unit\": \"kB\",\n \"value\": \"42\"\n },\n \"type\": \"calloutValue\"\n }\n ],\n \"isVisible\": \"true\",\n \"layout\": {\n \"default\": {\n \"height\": 8,\n \"width\": 2,\n \"x\": 0,\n \"y\": 0\n }\n }\n },\n \"type\": \"gridCell\"\n }\n ]\n },\n \"type\": \"grid\"\n }\n ],\n \"description\": \"This is a simple example app\",\n \"name\": \"Example App\",\n \"queries\": [],\n \"rootInstanceName\": \"grid0\"\n },\n \"type\": \"appDefinitions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\",\n \"type\": \"appDefinitions\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"components\": [\n {\n \"events\": [],\n \"name\": \"grid0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"gridCell0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"calloutValue0\",\n \"properties\": {\n \"isDisabled\": false,\n \"isLoading\": false,\n \"isVisible\": true,\n \"label\": \"CPU Usage\",\n \"size\": \"sm\",\n \"style\": \"vivid_yellow\",\n \"unit\": \"kB\",\n \"value\": \"42\"\n },\n \"type\": \"calloutValue\"\n }\n ],\n \"isVisible\": \"true\",\n \"layout\": {\n \"default\": {\n \"height\": 8,\n \"width\": 2,\n \"x\": 0,\n \"y\": 0\n }\n }\n },\n \"type\": \"gridCell\"\n }\n ]\n },\n \"type\": \"grid\"\n }\n ],\n \"description\": \"This is a simple example app\",\n \"name\": \"Example App\",\n \"queries\": [],\n \"rootInstanceName\": \"grid0\"\n },\n \"type\": \"appDefinitions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"components\": [\n {\n \"events\": [],\n \"name\": \"grid0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"gridCell0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"calloutValue0\",\n \"properties\": {\n \"isDisabled\": false,\n \"isLoading\": false,\n \"isVisible\": true,\n \"label\": \"CPU Usage\",\n \"size\": \"sm\",\n \"style\": \"vivid_yellow\",\n \"unit\": \"kB\",\n \"value\": \"42\"\n },\n \"type\": \"calloutValue\"\n }\n ],\n \"isVisible\": \"true\",\n \"layout\": {\n \"default\": {\n \"height\": 8,\n \"width\": 2,\n \"x\": 0,\n \"y\": 0\n }\n }\n },\n \"type\": \"gridCell\"\n }\n ]\n },\n \"type\": \"grid\"\n }\n ],\n \"description\": \"This is a simple example app\",\n \"name\": \"Example App\",\n \"queries\": [],\n \"rootInstanceName\": \"grid0\"\n },\n \"type\": \"appDefinitions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"components\": [\n {\n \"events\": [],\n \"name\": \"grid0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"gridCell0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"calloutValue0\",\n \"properties\": {\n \"isDisabled\": false,\n \"isLoading\": false,\n \"isVisible\": true,\n \"label\": \"CPU Usage\",\n \"size\": \"sm\",\n \"style\": \"vivid_yellow\",\n \"unit\": \"kB\",\n \"value\": \"42\"\n },\n \"type\": \"calloutValue\"\n }\n ],\n \"isVisible\": \"true\",\n \"layout\": {\n \"default\": {\n \"height\": 8,\n \"width\": 2,\n \"x\": 0,\n \"y\": 0\n }\n }\n },\n \"type\": \"gridCell\"\n }\n ]\n },\n \"type\": \"grid\"\n }\n ],\n \"description\": \"This is a simple example app\",\n \"name\": \"Example App\",\n \"queries\": [],\n \"rootInstanceName\": \"grid0\"\n },\n \"type\": \"appDefinitions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete Multiple Apps",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"aea2ed17-b45f-40d0-ba59-c86b7972c901\",\n \"type\": \"appDefinitions\"\n },\n {\n \"id\": \"f69bb8be-6168-4fe7-a30d-370256b6504a\",\n \"type\": \"appDefinitions\"\n },\n {\n \"id\": \"ab1ed73e-13ad-4426-b0df-a0ff8876a088\",\n \"type\": \"appDefinitions\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
]
},
"description": "Delete multiple apps in a single request from a list of app IDs."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"aea2ed17-b45f-40d0-ba59-c86b7972c901\",\n \"type\": \"appDefinitions\"\n },\n {\n \"id\": \"f69bb8be-6168-4fe7-a30d-370256b6504a\",\n \"type\": \"appDefinitions\"\n },\n {\n \"id\": \"ab1ed73e-13ad-4426-b0df-a0ff8876a088\",\n \"type\": \"appDefinitions\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\",\n \"type\": \"appDefinitions\"\n },\n {\n \"id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\",\n \"type\": \"appDefinitions\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"aea2ed17-b45f-40d0-ba59-c86b7972c901\",\n \"type\": \"appDefinitions\"\n },\n {\n \"id\": \"f69bb8be-6168-4fe7-a30d-370256b6504a\",\n \"type\": \"appDefinitions\"\n },\n {\n \"id\": \"ab1ed73e-13ad-4426-b0df-a0ff8876a088\",\n \"type\": \"appDefinitions\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"aea2ed17-b45f-40d0-ba59-c86b7972c901\",\n \"type\": \"appDefinitions\"\n },\n {\n \"id\": \"f69bb8be-6168-4fe7-a30d-370256b6504a\",\n \"type\": \"appDefinitions\"\n },\n {\n \"id\": \"ab1ed73e-13ad-4426-b0df-a0ff8876a088\",\n \"type\": \"appDefinitions\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"aea2ed17-b45f-40d0-ba59-c86b7972c901\",\n \"type\": \"appDefinitions\"\n },\n {\n \"id\": \"f69bb8be-6168-4fe7-a30d-370256b6504a\",\n \"type\": \"appDefinitions\"\n },\n {\n \"id\": \"ab1ed73e-13ad-4426-b0df-a0ff8876a088\",\n \"type\": \"appDefinitions\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"aea2ed17-b45f-40d0-ba59-c86b7972c901\",\n \"type\": \"appDefinitions\"\n },\n {\n \"id\": \"f69bb8be-6168-4fe7-a30d-370256b6504a\",\n \"type\": \"appDefinitions\"\n },\n {\n \"id\": \"ab1ed73e-13ad-4426-b0df-a0ff8876a088\",\n \"type\": \"appDefinitions\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get App",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id?version=proident dolor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"query": [
{
"key": "version",
"value": "proident dolor",
"description": "The version number of the app to retrieve. If not specified, the latest version is returned. Version numbers start at 1 and increment with each update. The special values `latest` and `deployed` can be used to retrieve the latest version or the published version, respectively."
}
],
"variable": [
{
"key": "app_id",
"value": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
}
]
},
"description": "Get the full definition of an app."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id?version=proident dolor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"query": [
{
"key": "version",
"value": "proident dolor",
"description": "The version number of the app to retrieve. If not specified, the latest version is returned. Version numbers start at 1 and increment with each update. The special values `latest` and `deployed` can be used to retrieve the latest version or the published version, respectively."
}
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "null"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id?version=proident dolor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"query": [
{
"key": "version",
"value": "proident dolor",
"description": "The version number of the app to retrieve. If not specified, the latest version is returned. Version numbers start at 1 and increment with each update. The special values `latest` and `deployed` can be used to retrieve the latest version or the published version, respectively."
}
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id?version=proident dolor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"query": [
{
"key": "version",
"value": "proident dolor",
"description": "The version number of the app to retrieve. If not specified, the latest version is returned. Version numbers start at 1 and increment with each update. The special values `latest` and `deployed` can be used to retrieve the latest version or the published version, respectively."
}
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id?version=proident dolor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"query": [
{
"key": "version",
"value": "proident dolor",
"description": "The version number of the app to retrieve. If not specified, the latest version is returned. Version numbers start at 1 and increment with each update. The special values `latest` and `deployed` can be used to retrieve the latest version or the published version, respectively."
}
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Gone",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id?version=proident dolor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"query": [
{
"key": "version",
"value": "proident dolor",
"description": "The version number of the app to retrieve. If not specified, the latest version is returned. Version numbers start at 1 and increment with each update. The special values `latest` and `deployed` can be used to retrieve the latest version or the published version, respectively."
}
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Gone",
"code": 410,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id?version=proident dolor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"query": [
{
"key": "version",
"value": "proident dolor",
"description": "The version number of the app to retrieve. If not specified, the latest version is returned. Version numbers start at 1 and increment with each update. The special values `latest` and `deployed` can be used to retrieve the latest version or the published version, respectively."
}
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update App",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"components\": [\n {\n \"events\": [],\n \"name\": \"grid0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"gridCell0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"calloutValue0\",\n \"properties\": {\n \"isDisabled\": false,\n \"isLoading\": false,\n \"isVisible\": true,\n \"label\": \"CPU Usage\",\n \"size\": \"sm\",\n \"style\": \"vivid_yellow\",\n \"unit\": \"kB\",\n \"value\": \"42\"\n },\n \"type\": \"calloutValue\"\n }\n ],\n \"isVisible\": \"true\",\n \"layout\": {\n \"default\": {\n \"height\": 8,\n \"width\": 2,\n \"x\": 0,\n \"y\": 0\n }\n }\n },\n \"type\": \"gridCell\"\n }\n ]\n },\n \"type\": \"grid\"\n }\n ],\n \"description\": \"This is a simple example app\",\n \"name\": \"Example App\",\n \"queries\": [],\n \"rootInstanceName\": \"grid0\"\n },\n \"id\": \"9e20cbaf-68da-45a6-9ccf-54193ac29fa5\",\n \"type\": \"appDefinitions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"variable": [
{
"key": "app_id",
"value": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
}
]
},
"description": "Update an existing app. This creates a new version of the app."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"components\": [\n {\n \"events\": [],\n \"name\": \"grid0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"gridCell0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"calloutValue0\",\n \"properties\": {\n \"isDisabled\": false,\n \"isLoading\": false,\n \"isVisible\": true,\n \"label\": \"CPU Usage\",\n \"size\": \"sm\",\n \"style\": \"vivid_yellow\",\n \"unit\": \"kB\",\n \"value\": \"42\"\n },\n \"type\": \"calloutValue\"\n }\n ],\n \"isVisible\": \"true\",\n \"layout\": {\n \"default\": {\n \"height\": 8,\n \"width\": 2,\n \"x\": 0,\n \"y\": 0\n }\n }\n },\n \"type\": \"gridCell\"\n }\n ]\n },\n \"type\": \"grid\"\n }\n ],\n \"description\": \"This is a simple example app\",\n \"name\": \"Example App\",\n \"queries\": [],\n \"rootInstanceName\": \"grid0\"\n },\n \"id\": \"9e20cbaf-68da-45a6-9ccf-54193ac29fa5\",\n \"type\": \"appDefinitions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "null"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"components\": [\n {\n \"events\": [],\n \"name\": \"grid0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"gridCell0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"calloutValue0\",\n \"properties\": {\n \"isDisabled\": false,\n \"isLoading\": false,\n \"isVisible\": true,\n \"label\": \"CPU Usage\",\n \"size\": \"sm\",\n \"style\": \"vivid_yellow\",\n \"unit\": \"kB\",\n \"value\": \"42\"\n },\n \"type\": \"calloutValue\"\n }\n ],\n \"isVisible\": \"true\",\n \"layout\": {\n \"default\": {\n \"height\": 8,\n \"width\": 2,\n \"x\": 0,\n \"y\": 0\n }\n }\n },\n \"type\": \"gridCell\"\n }\n ]\n },\n \"type\": \"grid\"\n }\n ],\n \"description\": \"This is a simple example app\",\n \"name\": \"Example App\",\n \"queries\": [],\n \"rootInstanceName\": \"grid0\"\n },\n \"id\": \"9e20cbaf-68da-45a6-9ccf-54193ac29fa5\",\n \"type\": \"appDefinitions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"components\": [\n {\n \"events\": [],\n \"name\": \"grid0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"gridCell0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"calloutValue0\",\n \"properties\": {\n \"isDisabled\": false,\n \"isLoading\": false,\n \"isVisible\": true,\n \"label\": \"CPU Usage\",\n \"size\": \"sm\",\n \"style\": \"vivid_yellow\",\n \"unit\": \"kB\",\n \"value\": \"42\"\n },\n \"type\": \"calloutValue\"\n }\n ],\n \"isVisible\": \"true\",\n \"layout\": {\n \"default\": {\n \"height\": 8,\n \"width\": 2,\n \"x\": 0,\n \"y\": 0\n }\n }\n },\n \"type\": \"gridCell\"\n }\n ]\n },\n \"type\": \"grid\"\n }\n ],\n \"description\": \"This is a simple example app\",\n \"name\": \"Example App\",\n \"queries\": [],\n \"rootInstanceName\": \"grid0\"\n },\n \"id\": \"9e20cbaf-68da-45a6-9ccf-54193ac29fa5\",\n \"type\": \"appDefinitions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"components\": [\n {\n \"events\": [],\n \"name\": \"grid0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"gridCell0\",\n \"properties\": {\n \"children\": [\n {\n \"events\": [],\n \"name\": \"calloutValue0\",\n \"properties\": {\n \"isDisabled\": false,\n \"isLoading\": false,\n \"isVisible\": true,\n \"label\": \"CPU Usage\",\n \"size\": \"sm\",\n \"style\": \"vivid_yellow\",\n \"unit\": \"kB\",\n \"value\": \"42\"\n },\n \"type\": \"calloutValue\"\n }\n ],\n \"isVisible\": \"true\",\n \"layout\": {\n \"default\": {\n \"height\": 8,\n \"width\": 2,\n \"x\": 0,\n \"y\": 0\n }\n }\n },\n \"type\": \"gridCell\"\n }\n ]\n },\n \"type\": \"grid\"\n }\n ],\n \"description\": \"This is a simple example app\",\n \"name\": \"Example App\",\n \"queries\": [],\n \"rootInstanceName\": \"grid0\"\n },\n \"id\": \"9e20cbaf-68da-45a6-9ccf-54193ac29fa5\",\n \"type\": \"appDefinitions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete App",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"variable": [
{
"key": "app_id",
"value": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
}
]
},
"description": "Delete a single app."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\",\n \"type\": \"appDefinitions\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Gone",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Gone",
"code": 410,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Publish App",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id",
"deployment"
],
"variable": [
{
"key": "app_id",
"value": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
}
]
},
"description": "Publish an app for use by other users. To ensure the app is accessible to the correct users, you also need to set a [Restriction Policy](https://docs.datadoghq.com/api/latest/restriction-policies/) on the app if a policy does not yet exist."
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id",
"deployment"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"app_version_id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\"\n },\n \"id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\",\n \"meta\": {\n \"created_at\": \"1963-06-23T09:08:50.640Z\",\n \"user_id\": 24410429,\n \"user_name\": \"laborum commodo\",\n \"user_uuid\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\"\n },\n \"type\": \"deployment\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id",
"deployment"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id",
"deployment"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id",
"deployment"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id",
"deployment"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Unpublish App",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id",
"deployment"
],
"variable": [
{
"key": "app_id",
"value": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
}
]
},
"description": "Unpublish an app, removing the live version of the app. Unpublishing creates a new instance of a `deployment` object on the app, with a nil `app_version_id` (`00000000-0000-0000-0000-000000000000`). The app can still be updated and published again in the future."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id",
"deployment"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"app_version_id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\"\n },\n \"id\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\",\n \"meta\": {\n \"created_at\": \"1989-07-18T08:17:39.328Z\",\n \"user_id\": -68448761,\n \"user_name\": \"sit\",\n \"user_uuid\": \"65bb1f25-52e1-4510-9f8d-22d1516ed693\"\n },\n \"type\": \"deployment\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id",
"deployment"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id",
"deployment"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id",
"deployment"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicing_9\": {},\n \"occaecat_5d\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"elit_4\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/app-builder/apps/:app_id/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"app-builder",
"apps",
":app_id",
"deployment"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Datadog App Builder provides a low-code solution to rapidly develop and integrate secure, customized applications into your monitoring stack that are built to accelerate remediation at scale. These API endpoints allow you to create, read, update, delete, and publish apps.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Application Security",
"item": [
{
"name": "Get a WAF exclusion filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id",
"value": "3b5-v82-ns6"
}
]
},
"description": "Retrieve a specific WAF exclusion filter using its identifier."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"event_query\": \"consequat co\",\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"metadata\": {\n \"added_at\": \"1986-03-10T13:23:39.578Z\",\n \"added_by\": \"consequat ipsum\",\n \"added_by_name\": \"laborum adipisicing exercitation et cillum\",\n \"modified_at\": \"1990-03-29T02:33:37.907Z\",\n \"modified_by\": \"Ut sed\",\n \"modified_by_name\": \"pariatur non quis sit Ut\"\n },\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"in_6\": \"in Ut\",\n \"elit54\": \"dolore ut adipisicing\",\n \"elit_a_\": \"eiusmod culpa sed\",\n \"quis7\": \"Ut\",\n \"dolorba\": \"deserunt ex\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ],\n \"search_query\": \"anim ad\"\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"exclusion_filter\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a WAF exclusion filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"labore_58\": \"nostrud mollit consequat officia\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ]\n },\n \"type\": \"exclusion_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters"
]
},
"description": "Create a new WAF exclusion filter with the given parameters.\n\nA request matched by an exclusion filter will be ignored by the Application Security WAF product.\nGo to https://app.datadoghq.com/security/appsec/passlist to review existing exclusion filters (also called passlist entries)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"labore_58\": \"nostrud mollit consequat officia\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ]\n },\n \"type\": \"exclusion_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"event_query\": \"consequat co\",\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"metadata\": {\n \"added_at\": \"1986-03-10T13:23:39.578Z\",\n \"added_by\": \"consequat ipsum\",\n \"added_by_name\": \"laborum adipisicing exercitation et cillum\",\n \"modified_at\": \"1990-03-29T02:33:37.907Z\",\n \"modified_by\": \"Ut sed\",\n \"modified_by_name\": \"pariatur non quis sit Ut\"\n },\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"in_6\": \"in Ut\",\n \"elit54\": \"dolore ut adipisicing\",\n \"elit_a_\": \"eiusmod culpa sed\",\n \"quis7\": \"Ut\",\n \"dolorba\": \"deserunt ex\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ],\n \"search_query\": \"anim ad\"\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"exclusion_filter\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"labore_58\": \"nostrud mollit consequat officia\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ]\n },\n \"type\": \"exclusion_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"labore_58\": \"nostrud mollit consequat officia\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ]\n },\n \"type\": \"exclusion_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"labore_58\": \"nostrud mollit consequat officia\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ]\n },\n \"type\": \"exclusion_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"labore_58\": \"nostrud mollit consequat officia\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ]\n },\n \"type\": \"exclusion_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List all WAF exclusion filters",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters"
]
},
"description": "Retrieve a list of WAF exclusion filters."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"event_query\": \"Excepteur quis aute\",\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"metadata\": {\n \"added_at\": \"1984-05-07T01:57:01.686Z\",\n \"added_by\": \"do in\",\n \"added_by_name\": \"\",\n \"modified_at\": \"2008-09-09T12:25:01.882Z\",\n \"modified_by\": \"labore est consectetur inc\",\n \"modified_by_name\": \"dolore exercit\"\n },\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"aliqua921\": \"in sit aliquip\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ],\n \"search_query\": \"cillum\"\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"exclusion_filter\"\n },\n {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"event_query\": \"enim dolor eu est occaecat\",\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"metadata\": {\n \"added_at\": \"2013-09-05T12:18:08.411Z\",\n \"added_by\": \"officia deserunt\",\n \"added_by_name\": \"Duis dolore\",\n \"modified_at\": \"1963-03-09T01:21:54.533Z\",\n \"modified_by\": \"enim in\",\n \"modified_by_name\": \"par\"\n },\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"id_16f\": \"sit occaecat cupidatat\",\n \"ea_3c8\": \"minim et ea\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ],\n \"search_query\": \"Lorem quis\"\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"exclusion_filter\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a WAF exclusion filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"nostrud_b\": \"sunt nisi\",\n \"do_3c9\": \"sunt est Ut sit\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ]\n },\n \"type\": \"exclusion_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id",
"value": "3b5-v82-ns6"
}
]
},
"description": "Update a specific WAF exclusion filter using its identifier.\nReturns the exclusion filter object when the request is successful."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"nostrud_b\": \"sunt nisi\",\n \"do_3c9\": \"sunt est Ut sit\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ]\n },\n \"type\": \"exclusion_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"event_query\": \"consequat co\",\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"metadata\": {\n \"added_at\": \"1986-03-10T13:23:39.578Z\",\n \"added_by\": \"consequat ipsum\",\n \"added_by_name\": \"laborum adipisicing exercitation et cillum\",\n \"modified_at\": \"1990-03-29T02:33:37.907Z\",\n \"modified_by\": \"Ut sed\",\n \"modified_by_name\": \"pariatur non quis sit Ut\"\n },\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"in_6\": \"in Ut\",\n \"elit54\": \"dolore ut adipisicing\",\n \"elit_a_\": \"eiusmod culpa sed\",\n \"quis7\": \"Ut\",\n \"dolorba\": \"deserunt ex\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ],\n \"search_query\": \"anim ad\"\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"exclusion_filter\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"nostrud_b\": \"sunt nisi\",\n \"do_3c9\": \"sunt est Ut sit\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ]\n },\n \"type\": \"exclusion_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"nostrud_b\": \"sunt nisi\",\n \"do_3c9\": \"sunt est Ut sit\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ]\n },\n \"type\": \"exclusion_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"nostrud_b\": \"sunt nisi\",\n \"do_3c9\": \"sunt est Ut sit\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ]\n },\n \"type\": \"exclusion_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"nostrud_b\": \"sunt nisi\",\n \"do_3c9\": \"sunt est Ut sit\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ]\n },\n \"type\": \"exclusion_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Exclude false positives on a path\",\n \"enabled\": true,\n \"ip_list\": [\n \"198.51.100.72\",\n \"198.51.100.72\"\n ],\n \"on_match\": \"monitor\",\n \"parameters\": [\n \"list.search.query\",\n \"list.search.query\"\n ],\n \"path_glob\": \"/accounts/*\",\n \"rules_target\": [\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\",\n \"nostrud_b\": \"sunt nisi\",\n \"do_3c9\": \"sunt est Ut sit\"\n }\n },\n {\n \"rule_id\": \"dog-913-009\",\n \"tags\": {\n \"category\": \"attack_attempt\",\n \"type\": \"lfi\"\n }\n }\n ],\n \"scope\": [\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n },\n {\n \"env\": \"www\",\n \"service\": \"prod\"\n }\n ]\n },\n \"type\": \"exclusion_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a WAF exclusion filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id",
"value": "3b5-v82-ns6"
}
]
},
"description": "Delete a specific WAF exclusion filter using its identifier."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"exclusion_filters",
":exclusion_filter_id"
],
"variable": [
{
"key": "exclusion_filter_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a WAF custom rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id",
"value": "3b5-v82-ns6"
}
]
},
"description": "Retrieve a WAF custom rule by ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"qui velit nisi occaecat\",\n \"veniam ullamco\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"culpa veniam adipisicing\",\n \"consectetur ut do\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"anim laborum\",\n \"consectetur tempor sed labore\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"enim incididunt cupidatat amet\",\n \"amet d\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"veniam eu nisi\",\n \"eu nostrud commodo ullamco\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"Excepteur aute ci\",\n \"Ut laboris\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"metadata\": {\n \"added_at\": \"2021-01-01T00:00:00Z\",\n \"added_by\": \"john.doe@datadoghq.com\",\n \"added_by_name\": \"John Doe\",\n \"modified_at\": \"2021-01-01T00:00:00Z\",\n \"modified_by\": \"john.doe@datadoghq.com\",\n \"modified_by_name\": \"John Doe\"\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"id\": \"2857c47d-1e3a-4300-8b2f-dc24089c084b\",\n \"type\": \"custom_rule\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a WAF custom rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from a bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"minim sunt reprehenderit et Ut\",\n \"in dolore cillum aliqua adipisicing\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"non\",\n \"est dolore sit id aliqua\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"elit\",\n \"ea dolore enim incididunt\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"esse nisi Excepteur elit anim\",\n \"dolore occaecat sint dolo\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"et incididunt Duis occaec\",\n \"sit do in aliqua fugiat\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"exercitation ut\",\n \"officia\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"type\": \"custom_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules"
]
},
"description": "Create a new WAF custom rule with the given parameters."
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from a bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"minim sunt reprehenderit et Ut\",\n \"in dolore cillum aliqua adipisicing\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"non\",\n \"est dolore sit id aliqua\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"elit\",\n \"ea dolore enim incididunt\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"esse nisi Excepteur elit anim\",\n \"dolore occaecat sint dolo\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"et incididunt Duis occaec\",\n \"sit do in aliqua fugiat\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"exercitation ut\",\n \"officia\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"type\": \"custom_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"qui velit nisi occaecat\",\n \"veniam ullamco\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"culpa veniam adipisicing\",\n \"consectetur ut do\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"anim laborum\",\n \"consectetur tempor sed labore\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"enim incididunt cupidatat amet\",\n \"amet d\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"veniam eu nisi\",\n \"eu nostrud commodo ullamco\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"Excepteur aute ci\",\n \"Ut laboris\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"metadata\": {\n \"added_at\": \"2021-01-01T00:00:00Z\",\n \"added_by\": \"john.doe@datadoghq.com\",\n \"added_by_name\": \"John Doe\",\n \"modified_at\": \"2021-01-01T00:00:00Z\",\n \"modified_by\": \"john.doe@datadoghq.com\",\n \"modified_by_name\": \"John Doe\"\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"id\": \"2857c47d-1e3a-4300-8b2f-dc24089c084b\",\n \"type\": \"custom_rule\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from a bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"minim sunt reprehenderit et Ut\",\n \"in dolore cillum aliqua adipisicing\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"non\",\n \"est dolore sit id aliqua\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"elit\",\n \"ea dolore enim incididunt\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"esse nisi Excepteur elit anim\",\n \"dolore occaecat sint dolo\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"et incididunt Duis occaec\",\n \"sit do in aliqua fugiat\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"exercitation ut\",\n \"officia\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"type\": \"custom_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from a bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"minim sunt reprehenderit et Ut\",\n \"in dolore cillum aliqua adipisicing\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"non\",\n \"est dolore sit id aliqua\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"elit\",\n \"ea dolore enim incididunt\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"esse nisi Excepteur elit anim\",\n \"dolore occaecat sint dolo\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"et incididunt Duis occaec\",\n \"sit do in aliqua fugiat\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"exercitation ut\",\n \"officia\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"type\": \"custom_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from a bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"minim sunt reprehenderit et Ut\",\n \"in dolore cillum aliqua adipisicing\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"non\",\n \"est dolore sit id aliqua\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"elit\",\n \"ea dolore enim incididunt\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"esse nisi Excepteur elit anim\",\n \"dolore occaecat sint dolo\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"et incididunt Duis occaec\",\n \"sit do in aliqua fugiat\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"exercitation ut\",\n \"officia\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"type\": \"custom_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from a bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"minim sunt reprehenderit et Ut\",\n \"in dolore cillum aliqua adipisicing\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"non\",\n \"est dolore sit id aliqua\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"elit\",\n \"ea dolore enim incididunt\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"esse nisi Excepteur elit anim\",\n \"dolore occaecat sint dolo\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"et incididunt Duis occaec\",\n \"sit do in aliqua fugiat\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"exercitation ut\",\n \"officia\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"type\": \"custom_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List all WAF custom rules",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules"
]
},
"description": "Retrieve a list of WAF custom rule."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"laborum\",\n \"do culpa nostrud in nulla\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"dolore ad aliquip sit\",\n \"in aute sit\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"velit\",\n \"cillum sint ad\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"in labore ad officia\",\n \"reprehenderit\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"\",\n \"veniam Excepteur reprehenderit voluptate\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"consectetur nulla\",\n \"cillum voluptate dolor\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"metadata\": {\n \"added_at\": \"2021-01-01T00:00:00Z\",\n \"added_by\": \"john.doe@datadoghq.com\",\n \"added_by_name\": \"John Doe\",\n \"modified_at\": \"2021-01-01T00:00:00Z\",\n \"modified_by\": \"john.doe@datadoghq.com\",\n \"modified_by_name\": \"John Doe\"\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"id\": \"2857c47d-1e3a-4300-8b2f-dc24089c084b\",\n \"type\": \"custom_rule\"\n },\n {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"laborum dolor in\",\n \"culpa nisi\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"ut\",\n \"minim consectetur eu aute s\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"qui irure cupidatat in\",\n \"do sint ut exercitation in\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"ullamco occaecat\",\n \"elit est nostrud\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"Lorem labore amet\",\n \"nisi nulla\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"tempor ad in Duis ea\",\n \"Excepteur reprehenderit\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"metadata\": {\n \"added_at\": \"2021-01-01T00:00:00Z\",\n \"added_by\": \"john.doe@datadoghq.com\",\n \"added_by_name\": \"John Doe\",\n \"modified_at\": \"2021-01-01T00:00:00Z\",\n \"modified_by\": \"john.doe@datadoghq.com\",\n \"modified_by_name\": \"John Doe\"\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"id\": \"2857c47d-1e3a-4300-8b2f-dc24089c084b\",\n \"type\": \"custom_rule\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a WAF Custom Rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"occaecat do dolor ipsum\",\n \"non id \"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"eiusmod\",\n \"Duis dolor aute\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"esse nisi\",\n \"id\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"ut ullamco in fugiat\",\n \"id commodo\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"cupidatat reprehenderit dolor commodo\",\n \"sint aliqua\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"minim elit labore irure\",\n \"cupidatat commodo irure magna consequat\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"type\": \"custom_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id",
"value": "3b5-v82-ns6"
}
]
},
"description": "Update a specific WAF custom Rule.\nReturns the Custom Rule object when the request is successful."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"occaecat do dolor ipsum\",\n \"non id \"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"eiusmod\",\n \"Duis dolor aute\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"esse nisi\",\n \"id\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"ut ullamco in fugiat\",\n \"id commodo\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"cupidatat reprehenderit dolor commodo\",\n \"sint aliqua\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"minim elit labore irure\",\n \"cupidatat commodo irure magna consequat\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"type\": \"custom_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"qui velit nisi occaecat\",\n \"veniam ullamco\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"culpa veniam adipisicing\",\n \"consectetur ut do\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"anim laborum\",\n \"consectetur tempor sed labore\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"enim incididunt cupidatat amet\",\n \"amet d\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"veniam eu nisi\",\n \"eu nostrud commodo ullamco\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"Excepteur aute ci\",\n \"Ut laboris\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"metadata\": {\n \"added_at\": \"2021-01-01T00:00:00Z\",\n \"added_by\": \"john.doe@datadoghq.com\",\n \"added_by_name\": \"John Doe\",\n \"modified_at\": \"2021-01-01T00:00:00Z\",\n \"modified_by\": \"john.doe@datadoghq.com\",\n \"modified_by_name\": \"John Doe\"\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"id\": \"2857c47d-1e3a-4300-8b2f-dc24089c084b\",\n \"type\": \"custom_rule\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"occaecat do dolor ipsum\",\n \"non id \"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"eiusmod\",\n \"Duis dolor aute\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"esse nisi\",\n \"id\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"ut ullamco in fugiat\",\n \"id commodo\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"cupidatat reprehenderit dolor commodo\",\n \"sint aliqua\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"minim elit labore irure\",\n \"cupidatat commodo irure magna consequat\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"type\": \"custom_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"occaecat do dolor ipsum\",\n \"non id \"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"eiusmod\",\n \"Duis dolor aute\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"esse nisi\",\n \"id\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"ut ullamco in fugiat\",\n \"id commodo\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"cupidatat reprehenderit dolor commodo\",\n \"sint aliqua\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"minim elit labore irure\",\n \"cupidatat commodo irure magna consequat\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"type\": \"custom_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"occaecat do dolor ipsum\",\n \"non id \"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"eiusmod\",\n \"Duis dolor aute\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"esse nisi\",\n \"id\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"ut ullamco in fugiat\",\n \"id commodo\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"cupidatat reprehenderit dolor commodo\",\n \"sint aliqua\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"minim elit labore irure\",\n \"cupidatat commodo irure magna consequat\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"type\": \"custom_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"occaecat do dolor ipsum\",\n \"non id \"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"eiusmod\",\n \"Duis dolor aute\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"esse nisi\",\n \"id\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"ut ullamco in fugiat\",\n \"id commodo\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"cupidatat reprehenderit dolor commodo\",\n \"sint aliqua\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"minim elit labore irure\",\n \"cupidatat commodo irure magna consequat\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"type\": \"custom_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": false,\n \"blocking\": false,\n \"name\": \"Block request from bad useragent\",\n \"tags\": {\n \"category\": \"business_logic\",\n \"type\": \"users.login.success\"\n },\n \"conditions\": [\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"occaecat do dolor ipsum\",\n \"non id \"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"eiusmod\",\n \"Duis dolor aute\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"esse nisi\",\n \"id\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n },\n {\n \"operator\": \"match_regex\",\n \"parameters\": {\n \"inputs\": [\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"ut ullamco in fugiat\",\n \"id commodo\"\n ]\n },\n {\n \"address\": \"server.db.statement\",\n \"key_path\": [\n \"cupidatat reprehenderit dolor commodo\",\n \"sint aliqua\"\n ]\n }\n ],\n \"data\": \"blocked_users\",\n \"list\": [\n \"minim elit labore irure\",\n \"cupidatat commodo irure magna consequat\"\n ],\n \"options\": {\n \"case_sensitive\": false,\n \"min_length\": 0\n },\n \"regex\": \"path.*\",\n \"value\": \"custom_tag\"\n }\n }\n ],\n \"action\": {\n \"action\": \"block_request\",\n \"parameters\": {\n \"location\": \"/blocking\",\n \"status_code\": 403\n }\n },\n \"path_glob\": \"/api/search/*\",\n \"scope\": [\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n },\n {\n \"service\": \"billing-service\",\n \"env\": \"prod\"\n }\n ]\n },\n \"type\": \"custom_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a WAF Custom Rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id",
"value": "3b5-v82-ns6"
}
]
},
"description": "Delete a specific WAF custom rule."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"asm",
"waf",
"custom_rules",
":custom_rule_id"
],
"variable": [
{
"key": "custom_rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "[Datadog Application Security](https://docs.datadoghq.com/security/application_security/) provides protection against\napplication-level attacks that aim to exploit code-level vulnerabilities,\nsuch as Server-Side-Request-Forgery (SSRF), SQL injection, Log4Shell, and\nReflected Cross-Site-Scripting (XSS). You can monitor and protect apps\nhosted directly on a server, Docker, Kubernetes, Amazon ECS, and (for\nsupported languages) AWS Fargate.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Audit",
"item": [
{
"name": "Search Audit Logs events",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@type:session AND @session.type:user\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": 67121691,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/audit/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"audit",
"events",
"search"
]
},
"description": "List endpoint returns Audit Logs events that match an Audit search query.\n[Results are paginated][1].\n\nUse this endpoint to build complex Audit Logs events filtering and search.\n\n[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@type:session AND @session.type:user\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": 67121691,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/audit/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"audit",
"events",
"search"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"message\": \"aute\",\n \"service\": \"web-app\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"audit\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"message\": \"ut velit ipsum\",\n \"service\": \"web-app\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"audit\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@type:session AND @session.type:user\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": 67121691,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/audit/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"audit",
"events",
"search"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@type:session AND @session.type:user\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": 67121691,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/audit/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"audit",
"events",
"search"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@type:session AND @session.type:user\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": 67121691,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/audit/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"audit",
"events",
"search"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a list of Audit Logs events",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/audit/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"audit",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@type:session @application_id:xxxx",
"description": "Search query following Audit Logs syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
},
"description": "List endpoint returns events that match a Audit Logs search query.\n[Results are paginated][1].\n\nUse this endpoint to see your latest Audit Logs events.\n\n[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/audit/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"audit",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@type:session @application_id:xxxx",
"description": "Search query following Audit Logs syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"message\": \"aute\",\n \"service\": \"web-app\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"audit\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"message\": \"ut velit ipsum\",\n \"service\": \"web-app\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"audit\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/audit/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"audit",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@type:session @application_id:xxxx",
"description": "Search query following Audit Logs syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/audit/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"audit",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@type:session @application_id:xxxx",
"description": "Search query following Audit Logs syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/audit/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"audit",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@type:session @application_id:xxxx",
"description": "Search query following Audit Logs syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Search your Audit Logs events over HTTP.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Authentication",
"item": [
{
"name": "Validate API key",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/validate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"validate"
]
},
"description": "Check if the API key (not the APP key) is valid. If invalid, a 403 is returned."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/validate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"validate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"valid\": true\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/validate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"validate"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/validate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"validate"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "All requests to Datadog’s API must be authenticated.\nRequests that write data require reporting access and require an `API key`.\nRequests that read data require full access and also require an `application key`.\n\n**Note:** All Datadog API clients are configured by default to consume Datadog US site APIs.\nIf you are on the Datadog EU site, set the environment variable `DATADOG_HOST` to\n`https://api.datadoghq.eu` or override this value directly when creating your client.\n\n[Manage your account’s API and application keys](https://app.datadoghq.com/organization-settings/) in Datadog, and see the [API and Application Keys page](https://docs.datadoghq.com/account_management/api-app-keys/) in the documentation.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "AuthN Mappings",
"item": [
{
"name": "Get an AuthN Mapping by UUID",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id",
"value": "pariatur consequat"
}
]
},
"description": "Get an AuthN Mapping specified by the AuthN Mapping UUID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\",\n \"created_at\": \"2022-03-27T05:34:57.971Z\",\n \"modified_at\": \"2018-01-30T20:52:29.320Z\",\n \"saml_assertion_attribute_id\": \"0\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n },\n \"saml_assertion_attribute\": {\n \"data\": {\n \"id\": \"0\",\n \"type\": \"saml_assertion_attributes\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"0\",\n \"type\": \"saml_assertion_attributes\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n }\n },\n {\n \"id\": \"0\",\n \"type\": \"saml_assertion_attributes\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n }\n }\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Edit an AuthN Mapping",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id",
"value": "pariatur consequat"
}
]
},
"description": "Edit an AuthN Mapping."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\",\n \"created_at\": \"2022-03-27T05:34:57.971Z\",\n \"modified_at\": \"2018-01-30T20:52:29.320Z\",\n \"saml_assertion_attribute_id\": \"0\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n },\n \"saml_assertion_attribute\": {\n \"data\": {\n \"id\": \"0\",\n \"type\": \"saml_assertion_attributes\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"0\",\n \"type\": \"saml_assertion_attributes\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n }\n },\n {\n \"id\": \"0\",\n \"type\": \"saml_assertion_attributes\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n }\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unprocessable Entity",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete an AuthN Mapping",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete an AuthN Mapping specified by AuthN Mapping UUID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List all AuthN Mappings",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "saml_assertion_attribute.attribute_value",
"description": "Sort AuthN Mappings depending on the given field.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all mappings by the given string.",
"disabled": true
}
]
},
"description": "List all AuthN Mappings in the org."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "saml_assertion_attribute.attribute_value",
"description": "Sort AuthN Mappings depending on the given field.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all mappings by the given string.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\",\n \"created_at\": \"2008-01-17T13:40:13.550Z\",\n \"modified_at\": \"1959-02-09T23:38:27.532Z\",\n \"saml_assertion_attribute_id\": \"0\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n },\n \"saml_assertion_attribute\": {\n \"data\": {\n \"id\": \"0\",\n \"type\": \"saml_assertion_attributes\"\n }\n }\n }\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\",\n \"created_at\": \"1958-05-22T04:43:54.847Z\",\n \"modified_at\": \"1994-03-23T11:41:18.589Z\",\n \"saml_assertion_attribute_id\": \"0\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n },\n \"saml_assertion_attribute\": {\n \"data\": {\n \"id\": \"0\",\n \"type\": \"saml_assertion_attributes\"\n }\n }\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"0\",\n \"type\": \"saml_assertion_attributes\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n }\n },\n {\n \"id\": \"0\",\n \"type\": \"saml_assertion_attributes\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": -53695929,\n \"total_filtered_count\": 2646825\n }\n }\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "saml_assertion_attribute.attribute_value",
"description": "Sort AuthN Mappings depending on the given field.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all mappings by the given string.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "saml_assertion_attribute.attribute_value",
"description": "Sort AuthN Mappings depending on the given field.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all mappings by the given string.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create an AuthN Mapping",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings"
]
},
"description": "Create an AuthN Mapping."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\",\n \"created_at\": \"2022-03-27T05:34:57.971Z\",\n \"modified_at\": \"2018-01-30T20:52:29.320Z\",\n \"saml_assertion_attribute_id\": \"0\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n },\n \"saml_assertion_attribute\": {\n \"data\": {\n \"id\": \"0\",\n \"type\": \"saml_assertion_attributes\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"0\",\n \"type\": \"saml_assertion_attributes\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n }\n },\n {\n \"id\": \"0\",\n \"type\": \"saml_assertion_attributes\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n }\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"member-of\",\n \"attribute_value\": \"Development\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "[The AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)\nis used to automatically map groups of users to roles in Datadog using attributes\nsent from Identity Providers. Use these endpoints to manage your AuthN Mappings.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "AWS Integration",
"item": [
{
"name": "Get all AWS tag filters",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/filtering?account_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"filtering"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "(Required) Only return AWS filters that matches this `account_id`."
}
]
},
"description": "Get all AWS tag filters."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/filtering?account_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"filtering"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "(Required) Only return AWS filters that matches this `account_id`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"filters\": [\n {\n \"namespace\": \"step_functions\",\n \"tag_filter_str\": \"prod*\"\n },\n {\n \"namespace\": \"network_elb\",\n \"tag_filter_str\": \"prod*\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/filtering?account_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"filtering"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "(Required) Only return AWS filters that matches this `account_id`."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/filtering?account_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"filtering"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "(Required) Only return AWS filters that matches this `account_id`."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/filtering?account_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"filtering"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "(Required) Only return AWS filters that matches this `account_id`."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Set an AWS tag filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"123456789012\",\n \"namespace\": \"application_elb\",\n \"tag_filter_str\": \"prod*\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/filtering",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"filtering"
]
},
"description": "Set an AWS tag filter."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"123456789012\",\n \"namespace\": \"application_elb\",\n \"tag_filter_str\": \"prod*\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/filtering",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"filtering"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"123456789012\",\n \"namespace\": \"application_elb\",\n \"tag_filter_str\": \"prod*\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/filtering",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"filtering"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"123456789012\",\n \"namespace\": \"application_elb\",\n \"tag_filter_str\": \"prod*\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/filtering",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"filtering"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"123456789012\",\n \"namespace\": \"application_elb\",\n \"tag_filter_str\": \"prod*\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/filtering",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"filtering"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a tag filtering entry",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"FAKEAC0FAKEAC2FAKEAC\",\n \"namespace\": \"network_elb\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/filtering",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"filtering"
]
},
"description": "Delete a tag filtering entry."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"FAKEAC0FAKEAC2FAKEAC\",\n \"namespace\": \"network_elb\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/filtering",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"filtering"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"FAKEAC0FAKEAC2FAKEAC\",\n \"namespace\": \"network_elb\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/filtering",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"filtering"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"FAKEAC0FAKEAC2FAKEAC\",\n \"namespace\": \"network_elb\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/filtering",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"filtering"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"FAKEAC0FAKEAC2FAKEAC\",\n \"namespace\": \"network_elb\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/filtering",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"filtering"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Generate a new external ID",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/generate_new_external_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"generate_new_external_id"
]
},
"description": "Generate a new AWS external ID for a given AWS account ID and role name pair."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/generate_new_external_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"generate_new_external_id"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"external_id\": \"esse\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/generate_new_external_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"generate_new_external_id"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/generate_new_external_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"generate_new_external_id"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/generate_new_external_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"generate_new_external_id"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List namespace rules",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/available_namespace_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"available_namespace_rules"
]
},
"description": "List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/available_namespace_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"available_namespace_rules"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "[\n \"namespace1\",\n \"namespace2\",\n \"namespace3\"\n]"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/available_namespace_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"available_namespace_rules"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/available_namespace_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"available_namespace_rules"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get AWS integration IAM permissions",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/aws/iam_permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"aws",
"iam_permissions"
]
},
"description": "Get all AWS IAM permissions required for the AWS integration."
},
"response": [
{
"name": "AWS IAM Permissions object",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/aws/iam_permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"aws",
"iam_permissions"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"permissions\": [\n \"account:GetContactInformation\",\n \"amplify:ListApps\",\n \"amplify:ListArtifacts\",\n \"amplify:ListBackendEnvironments\",\n \"amplify:ListBranches\"\n ]\n },\n \"id\": \"permissions\",\n \"type\": \"permissions\"\n }\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/aws/iam_permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"aws",
"iam_permissions"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List all AWS integrations",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws?account_id=sit esse&role_name=sit esse&access_key_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `account_id`."
},
{
"key": "role_name",
"value": "sit esse",
"description": "Only return AWS accounts that matches this role_name."
},
{
"key": "access_key_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `access_key_id`."
}
]
},
"description": "List all Datadog-AWS integrations available in your Datadog organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws?account_id=sit esse&role_name=sit esse&access_key_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `account_id`."
},
{
"key": "role_name",
"value": "sit esse",
"description": "Only return AWS accounts that matches this role_name."
},
{
"key": "access_key_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `access_key_id`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"accounts\": [\n {\n \"access_key_id\": \"ut fugiat anim sit est\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"laboris cillum ad paria\"\n },\n {\n \"access_key_id\": \"esse\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"nulla non Ut\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws?account_id=sit esse&role_name=sit esse&access_key_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `account_id`."
},
{
"key": "role_name",
"value": "sit esse",
"description": "Only return AWS accounts that matches this role_name."
},
{
"key": "access_key_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `access_key_id`."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws?account_id=sit esse&role_name=sit esse&access_key_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `account_id`."
},
{
"key": "role_name",
"value": "sit esse",
"description": "Only return AWS accounts that matches this role_name."
},
{
"key": "access_key_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `access_key_id`."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws?account_id=sit esse&role_name=sit esse&access_key_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `account_id`."
},
{
"key": "role_name",
"value": "sit esse",
"description": "Only return AWS accounts that matches this role_name."
},
{
"key": "access_key_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `access_key_id`."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete an AWS integration",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"exercitation \",\n \"account_id\": \"123456789012\",\n \"role_name\": \"DatadogAWSIntegrationRole\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
]
},
"description": "Delete a Datadog-AWS integration matching the specified `account_id` and `role_name parameters`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"exercitation \",\n \"account_id\": \"123456789012\",\n \"role_name\": \"DatadogAWSIntegrationRole\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"exercitation \",\n \"account_id\": \"123456789012\",\n \"role_name\": \"DatadogAWSIntegrationRole\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"exercitation \",\n \"account_id\": \"123456789012\",\n \"role_name\": \"DatadogAWSIntegrationRole\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict Error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"exercitation \",\n \"account_id\": \"123456789012\",\n \"role_name\": \"DatadogAWSIntegrationRole\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"exercitation \",\n \"account_id\": \"123456789012\",\n \"role_name\": \"DatadogAWSIntegrationRole\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create an AWS integration",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
]
},
"description": "Create a Datadog-Amazon Web Services integration.\nUsing the `POST` method updates your integration configuration\nby adding your new configuration to the existing one in your Datadog organization.\nA unique AWS Account ID for role based authentication."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"external_id\": \"esse\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update an AWS integration",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws?account_id=sit esse&role_name=sit esse&access_key_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `account_id`."
},
{
"key": "role_name",
"value": "sit esse",
"description": "Only return AWS accounts that match this `role_name`.\nRequired if `account_id` is specified."
},
{
"key": "access_key_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `access_key_id`.\nRequired if none of the other two options are specified."
}
]
},
"description": "Update a Datadog-Amazon Web Services integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws?account_id=sit esse&role_name=sit esse&access_key_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `account_id`."
},
{
"key": "role_name",
"value": "sit esse",
"description": "Only return AWS accounts that match this `role_name`.\nRequired if `account_id` is specified."
},
{
"key": "access_key_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `access_key_id`.\nRequired if none of the other two options are specified."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws?account_id=sit esse&role_name=sit esse&access_key_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `account_id`."
},
{
"key": "role_name",
"value": "sit esse",
"description": "Only return AWS accounts that match this `role_name`.\nRequired if `account_id` is specified."
},
{
"key": "access_key_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `access_key_id`.\nRequired if none of the other two options are specified."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws?account_id=sit esse&role_name=sit esse&access_key_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `account_id`."
},
{
"key": "role_name",
"value": "sit esse",
"description": "Only return AWS accounts that match this `role_name`.\nRequired if `account_id` is specified."
},
{
"key": "access_key_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `access_key_id`.\nRequired if none of the other two options are specified."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict Error",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws?account_id=sit esse&role_name=sit esse&access_key_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `account_id`."
},
{
"key": "role_name",
"value": "sit esse",
"description": "Only return AWS accounts that match this `role_name`.\nRequired if `account_id` is specified."
},
{
"key": "access_key_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `access_key_id`.\nRequired if none of the other two options are specified."
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"access_key_id\": \"enim nulla eu eiusmod\",\n \"account_id\": \"123456789012\",\n \"account_specific_namespace_rules\": {\n \"auto_scaling\": false,\n \"opswork\": false\n },\n \"cspm_resource_collection_enabled\": true,\n \"excluded_regions\": [\n \"us-east-1\",\n \"us-west-2\"\n ],\n \"extended_resource_collection_enabled\": true,\n \"filter_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"host_tags\": [\n \"$KEY:$VALUE\"\n ],\n \"metrics_collection_enabled\": false,\n \"role_name\": \"DatadogAWSIntegrationRole\",\n \"secret_access_key\": \"in voluptate anim in\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws?account_id=sit esse&role_name=sit esse&access_key_id=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws"
],
"query": [
{
"key": "account_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `account_id`."
},
{
"key": "role_name",
"value": "sit esse",
"description": "Only return AWS accounts that match this `role_name`.\nRequired if `account_id` is specified."
},
{
"key": "access_key_id",
"value": "sit esse",
"description": "Only return AWS accounts that matches this `access_key_id`.\nRequired if none of the other two options are specified."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all Amazon EventBridge sources",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/event_bridge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"event_bridge"
]
},
"description": "Get all Amazon EventBridge sources."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/event_bridge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"event_bridge"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"accounts\": [\n {\n \"accountId\": \"123456789012\",\n \"eventHubs\": [\n {\n \"name\": \"consectetur ut aliqua cillum\",\n \"region\": \"tempor\"\n },\n {\n \"name\": \"commodo qui ad ut\",\n \"region\": \"veniam\"\n }\n ],\n \"tags\": [\n \"$KEY:$VALUE\"\n ]\n },\n {\n \"accountId\": \"123456789012\",\n \"eventHubs\": [\n {\n \"name\": \"aute quis voluptate do id\",\n \"region\": \"tempor Ut\"\n },\n {\n \"name\": \"velit non ea\",\n \"region\": \"aliquip aliqua sed inci\"\n }\n ],\n \"tags\": [\n \"$KEY:$VALUE\"\n ]\n }\n ],\n \"isInstalled\": true\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/event_bridge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"event_bridge"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/event_bridge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"event_bridge"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/event_bridge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"event_bridge"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create an Amazon EventBridge source",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"123456789012\",\n \"create_event_bus\": true,\n \"event_generator_name\": \"app-alerts\",\n \"region\": \"us-east-1\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/event_bridge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"event_bridge"
]
},
"description": "Create an Amazon EventBridge source."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"123456789012\",\n \"create_event_bus\": true,\n \"event_generator_name\": \"app-alerts\",\n \"region\": \"us-east-1\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/event_bridge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"event_bridge"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"event_source_name\": \"app-alerts-zyxw3210\",\n \"has_bus\": true,\n \"region\": \"us-east-1\",\n \"status\": \"created\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"123456789012\",\n \"create_event_bus\": true,\n \"event_generator_name\": \"app-alerts\",\n \"region\": \"us-east-1\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/event_bridge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"event_bridge"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"123456789012\",\n \"create_event_bus\": true,\n \"event_generator_name\": \"app-alerts\",\n \"region\": \"us-east-1\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/event_bridge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"event_bridge"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"123456789012\",\n \"create_event_bus\": true,\n \"event_generator_name\": \"app-alerts\",\n \"region\": \"us-east-1\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/event_bridge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"event_bridge"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete an Amazon EventBridge source",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"123456789012\",\n \"event_generator_name\": \"app-alerts-zyxw3210\",\n \"region\": \"us-east-1\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/event_bridge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"event_bridge"
]
},
"description": "Delete an Amazon EventBridge source."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"123456789012\",\n \"event_generator_name\": \"app-alerts-zyxw3210\",\n \"region\": \"us-east-1\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/event_bridge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"event_bridge"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"status\": \"empty\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"123456789012\",\n \"event_generator_name\": \"app-alerts-zyxw3210\",\n \"region\": \"us-east-1\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/event_bridge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"event_bridge"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"123456789012\",\n \"event_generator_name\": \"app-alerts-zyxw3210\",\n \"region\": \"us-east-1\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/event_bridge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"event_bridge"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"123456789012\",\n \"event_generator_name\": \"app-alerts-zyxw3210\",\n \"region\": \"us-east-1\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/event_bridge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"event_bridge"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Configure your Datadog-AWS integration directly through the Datadog API.\nFor more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services).",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "AWS Logs Integration",
"item": [
{
"name": "List all AWS Logs integrations",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs"
]
},
"description": "List all Datadog-AWS Logs integrations configured in your Datadog account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "[\n {\n \"account_id\": \"123456789101\",\n \"lambdas\": [],\n \"services\": [\n \"s3\",\n \"elb\",\n \"elbv2\",\n \"cloudfront\",\n \"redshift\",\n \"lambda\"\n ]\n }\n]"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Add AWS Log Lambda ARN",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"lambda_arn\": \"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs"
]
},
"description": "Attach the Lambda ARN of the Lambda created for the Datadog-AWS log collection to your AWS account ID to enable log collection."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"lambda_arn\": \"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"lambda_arn\": \"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"lambda_arn\": \"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"lambda_arn\": \"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete an AWS Logs integration",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"lambda_arn\": \"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs"
]
},
"description": "Delete a Datadog-AWS logs configuration by removing the specific Lambda ARN associated with a given AWS account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"lambda_arn\": \"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"lambda_arn\": \"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"lambda_arn\": \"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"lambda_arn\": \"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get list of AWS log ready services",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"services"
]
},
"description": "Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"services"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "[\n {\n \"id\": \"s3\",\n \"label\": \"S3 Access Logs\"\n },\n {\n \"id\": \"elb\",\n \"label\": \"Classic ELB Access Logs\"\n },\n {\n \"id\": \"elbv2\",\n \"label\": \"Application ELB Access Logs\"\n },\n {\n \"id\": \"cloudfront\",\n \"label\": \"CloudFront Access Logs\"\n },\n {\n \"id\": \"redshift\",\n \"label\": \"Redshift Logs\"\n },\n {\n \"id\": \"lambda\",\n \"label\": \"Lambda Cloudwatch Logs\"\n }\n]"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"services"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"services"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Enable an AWS Logs integration",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"services\": [\n \"s3\",\n \"elb\",\n \"elbv2\",\n \"cloudfront\",\n \"redshift\",\n \"lambda\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"services"
]
},
"description": "Enable automatic log collection for a list of services. This should be run after running `CreateAWSLambdaARN` to save the configuration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"services\": [\n \"s3\",\n \"elb\",\n \"elbv2\",\n \"cloudfront\",\n \"redshift\",\n \"lambda\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"services"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"services\": [\n \"s3\",\n \"elb\",\n \"elbv2\",\n \"cloudfront\",\n \"redshift\",\n \"lambda\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"services"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"services\": [\n \"s3\",\n \"elb\",\n \"elbv2\",\n \"cloudfront\",\n \"redshift\",\n \"lambda\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"services"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"services\": [\n \"s3\",\n \"elb\",\n \"elbv2\",\n \"cloudfront\",\n \"redshift\",\n \"lambda\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"services"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Check permissions for log services",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"services\": [\n \"s3\",\n \"elb\",\n \"elbv2\",\n \"cloudfront\",\n \"redshift\",\n \"lambda\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/services_async",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"services_async"
]
},
"description": "Test if permissions are present to add log-forwarding triggers for the\ngiven services and AWS account. Input is the same as for `EnableAWSLogServices`.\nDone async, so can be repeatedly polled in a non-blocking fashion until\nthe async request completes.\n\n- Returns a status of `created` when it's checking if the permissions exists\n in the AWS account.\n- Returns a status of `waiting` while checking.\n- Returns a status of `checked and ok` if the Lambda exists.\n- Returns a status of `error` if the Lambda does not exist."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"services\": [\n \"s3\",\n \"elb\",\n \"elbv2\",\n \"cloudfront\",\n \"redshift\",\n \"lambda\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/services_async",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"services_async"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"code\": \"no_such_config\",\n \"message\": \"AWS account 12345 has no Lambda config to update\"\n },\n {\n \"code\": \"no_such_config\",\n \"message\": \"AWS account 12345 has no Lambda config to update\"\n }\n ],\n \"status\": \"created\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"services\": [\n \"s3\",\n \"elb\",\n \"elbv2\",\n \"cloudfront\",\n \"redshift\",\n \"lambda\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/services_async",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"services_async"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"services\": [\n \"s3\",\n \"elb\",\n \"elbv2\",\n \"cloudfront\",\n \"redshift\",\n \"lambda\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/services_async",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"services_async"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"services\": [\n \"s3\",\n \"elb\",\n \"elbv2\",\n \"cloudfront\",\n \"redshift\",\n \"lambda\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/services_async",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"services_async"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Check that an AWS Lambda Function exists",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"lambda_arn\": \"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/check_async",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"check_async"
]
},
"description": "Test if permissions are present to add a log-forwarding triggers for the given services and AWS account. The input\nis the same as for Enable an AWS service log collection. Subsequent requests will always repeat the above, so this\nendpoint can be polled intermittently instead of blocking.\n\n- Returns a status of 'created' when it's checking if the Lambda exists in the account.\n- Returns a status of 'waiting' while checking.\n- Returns a status of 'checked and ok' if the Lambda exists.\n- Returns a status of 'error' if the Lambda does not exist."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"lambda_arn\": \"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/check_async",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"check_async"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"code\": \"no_such_config\",\n \"message\": \"AWS account 12345 has no Lambda config to update\"\n },\n {\n \"code\": \"no_such_config\",\n \"message\": \"AWS account 12345 has no Lambda config to update\"\n }\n ],\n \"status\": \"created\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"lambda_arn\": \"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/check_async",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"check_async"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"lambda_arn\": \"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/check_async",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"check_async"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_id\": \"1234567\",\n \"lambda_arn\": \"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/aws/logs/check_async",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"aws",
"logs",
"check_async"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Configure your Datadog-AWS-Logs integration directly through Datadog API.\nFor more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection).",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Azure Integration",
"item": [
{
"name": "List all Azure integrations",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
},
"description": "List all Datadog-Azure integrations configured in your Datadog account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "[\n {\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n },\n {\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n }\n]"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create an Azure integration",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
},
"description": "Create a Datadog-Azure integration.\n\nUsing the `POST` method updates your integration configuration by adding your new\nconfiguration to the existing one in your Datadog organization.\n\nUsing the `PUT` method updates your integration configuration by replacing your\ncurrent configuration with the new one sent to your Datadog organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete an Azure integration",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
},
"description": "Delete a given Datadog-Azure integration from your Datadog account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update an Azure integration",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
},
"description": "Update a Datadog-Azure integration. Requires an existing `tenant_name` and `client_id`.\nAny other fields supplied will overwrite existing values. To overwrite `tenant_name` or `client_id`,\nuse `new_tenant_name` and `new_client_id`. To leave a field unchanged, do not supply that field in the payload."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update Azure integration host filters",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure/host_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure",
"host_filters"
]
},
"description": "Update the defined list of host filters for a given Datadog-Azure integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure/host_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure",
"host_filters"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure/host_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure",
"host_filters"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure/host_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure",
"host_filters"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"testc7f6-1234-5678-9101-3fcbf464test\",\n \"client_secret\": \"TestingRh2nx664kUy5dIApvM54T4AtO\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\n \"*\"\n ],\n \"host_filters\": \"key:value,filter:example\",\n \"metrics_enabled\": true,\n \"metrics_enabled_default\": true,\n \"new_client_id\": \"new1c7f6-1234-5678-9101-3fcbf464test\",\n \"new_tenant_name\": \"new1c44-1234-5678-9101-cc00736ftest\",\n \"resource_collection_enabled\": true,\n \"resource_provider_configs\": [\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n },\n {\n \"metrics_enabled\": true,\n \"namespace\": \"Microsoft.Compute\"\n }\n ],\n \"tenant_name\": \"testc44-1234-5678-9101-cc00736ftest\",\n \"usage_metrics_enabled\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/azure/host_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"azure",
"host_filters"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Configure your Datadog-Azure integration directly through the Datadog API.\nFor more information, see the [Datadog-Azure integration page](https://docs.datadoghq.com/integrations/azure).",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Case Management",
"item": [
{
"name": "Create a project",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Security Investigation\",\n \"key\": \"SEC\"\n },\n \"type\": \"project\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects"
]
},
"description": "Create a project."
},
"response": [
{
"name": "CREATED",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Security Investigation\",\n \"key\": \"SEC\"\n },\n \"type\": \"project\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"project\",\n \"attributes\": {\n \"key\": \"CASEM\",\n \"name\": \"veniam officia\"\n },\n \"relationships\": {\n \"member_team\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n },\n \"member_user\": {\n \"data\": []\n }\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Security Investigation\",\n \"key\": \"SEC\"\n },\n \"type\": \"project\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Security Investigation\",\n \"key\": \"SEC\"\n },\n \"type\": \"project\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Security Investigation\",\n \"key\": \"SEC\"\n },\n \"type\": \"project\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Security Investigation\",\n \"key\": \"SEC\"\n },\n \"type\": \"project\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Security Investigation\",\n \"key\": \"SEC\"\n },\n \"type\": \"project\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Search cases",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases?page[size]=10&page[number]=0&sort[field]=created_at&filter=status:open (team:case-management OR team:event-management)&sort[asc]=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort[field]",
"value": "created_at",
"description": "Specify which field to sort"
},
{
"key": "filter",
"value": "status:open (team:case-management OR team:event-management)",
"description": "Search query"
},
{
"key": "sort[asc]",
"value": "false",
"description": "Specify if order is ascending or not"
}
]
},
"description": "Search cases."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases?page[size]=10&page[number]=0&sort[field]=created_at&filter=status:open (team:case-management OR team:event-management)&sort[asc]=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort[field]",
"value": "created_at",
"description": "Specify which field to sort"
},
{
"key": "filter",
"value": "status:open (team:case-management OR team:event-management)",
"description": "Search query"
},
{
"key": "sort[asc]",
"value": "false",
"description": "Specify if order is ascending or not"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"1978-10-20T06:39:55.865Z\",\n \"attributes\": {\n \"eaf0f\": [\n \"aute mollit\",\n \"culpa in minim\"\n ],\n \"dolore4f\": [\n \"commodo nulla\",\n \"non\"\n ],\n \"enimf3\": [\n \"in\",\n \"minim enim\"\n ],\n \"dolor_9\": [\n \"dolore\",\n \"velit\"\n ]\n },\n \"closed_at\": \"1959-08-02T21:36:04.125Z\",\n \"created_at\": \"1947-02-25T05:44:35.163Z\",\n \"description\": \"officia pro\",\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"aliqu\",\n \"issue_key\": \"Duis\",\n \"issue_url\": \"sed Excepteur magna\",\n \"project_key\": \"officia nisi\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"CASEM-4523\",\n \"modified_at\": \"1958-12-28T11:57:55.022Z\",\n \"priority\": \"NOT_DEFINED\",\n \"service_now_ticket\": {\n \"result\": {\n \"sys_target_link\": \"sed magna eiusmod ex\"\n },\n \"status\": \"COMPLETED\"\n },\n \"status\": \"OPEN\",\n \"title\": \"Memory leak investigation on API\",\n \"type\": \"STANDARD\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n },\n {\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2000-03-26T07:56:01.902Z\",\n \"attributes\": {\n \"voluptate_8\": [\n \"dolore sint\",\n \"nulla ad\"\n ],\n \"dolor_65\": [\n \"commodo\",\n \"in sit adipisicin\"\n ],\n \"laboris_755\": [\n \"aliqua mollit in\",\n \"dolor magna\"\n ]\n },\n \"closed_at\": \"2021-02-15T04:08:14.127Z\",\n \"created_at\": \"2018-04-02T15:33:32.364Z\",\n \"description\": \"dolore amet\",\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"velit laboris\",\n \"issue_key\": \"aute qui\",\n \"issue_url\": \"veniam minim in\",\n \"project_key\": \"et aliqua quis dolore adipisicing\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"CASEM-4523\",\n \"modified_at\": \"2005-05-17T23:53:25.843Z\",\n \"priority\": \"NOT_DEFINED\",\n \"service_now_ticket\": {\n \"result\": {\n \"sys_target_link\": \"ipsum magna\"\n },\n \"status\": \"COMPLETED\"\n },\n \"status\": \"OPEN\",\n \"title\": \"Memory leak investigation on API\",\n \"type\": \"STANDARD\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"current\": 61616845,\n \"size\": 25834103,\n \"total\": 35231250\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases?page[size]=10&page[number]=0&sort[field]=created_at&filter=status:open (team:case-management OR team:event-management)&sort[asc]=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort[field]",
"value": "created_at",
"description": "Specify which field to sort"
},
{
"key": "filter",
"value": "status:open (team:case-management OR team:event-management)",
"description": "Search query"
},
{
"key": "sort[asc]",
"value": "false",
"description": "Specify if order is ascending or not"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases?page[size]=10&page[number]=0&sort[field]=created_at&filter=status:open (team:case-management OR team:event-management)&sort[asc]=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort[field]",
"value": "created_at",
"description": "Specify which field to sort"
},
{
"key": "filter",
"value": "status:open (team:case-management OR team:event-management)",
"description": "Search query"
},
{
"key": "sort[asc]",
"value": "false",
"description": "Specify if order is ascending or not"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases?page[size]=10&page[number]=0&sort[field]=created_at&filter=status:open (team:case-management OR team:event-management)&sort[asc]=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort[field]",
"value": "created_at",
"description": "Specify which field to sort"
},
{
"key": "filter",
"value": "status:open (team:case-management OR team:event-management)",
"description": "Search query"
},
{
"key": "sort[asc]",
"value": "false",
"description": "Specify if order is ascending or not"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases?page[size]=10&page[number]=0&sort[field]=created_at&filter=status:open (team:case-management OR team:event-management)&sort[asc]=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort[field]",
"value": "created_at",
"description": "Specify which field to sort"
},
{
"key": "filter",
"value": "status:open (team:case-management OR team:event-management)",
"description": "Search query"
},
{
"key": "sort[asc]",
"value": "false",
"description": "Specify if order is ascending or not"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases?page[size]=10&page[number]=0&sort[field]=created_at&filter=status:open (team:case-management OR team:event-management)&sort[asc]=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort[field]",
"value": "created_at",
"description": "Specify which field to sort"
},
{
"key": "filter",
"value": "status:open (team:case-management OR team:event-management)",
"description": "Search query"
},
{
"key": "sort[asc]",
"value": "false",
"description": "Specify if order is ascending or not"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a case",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"title\": \"Security breach investigation\",\n \"type\": \"STANDARD\",\n \"description\": \"Duis quis magna consequat\",\n \"priority\": \"NOT_DEFINED\"\n },\n \"type\": \"case\",\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n },\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases"
]
},
"description": "Create a Case"
},
"response": [
{
"name": "CREATED",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"title\": \"Security breach investigation\",\n \"type\": \"STANDARD\",\n \"description\": \"Duis quis magna consequat\",\n \"priority\": \"NOT_DEFINED\"\n },\n \"type\": \"case\",\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n },\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2025-06-29T07:24:34.883Z\",\n \"attributes\": {\n \"in8a\": [\n \"adipisicing dolor\",\n \"esse in ex\"\n ],\n \"fugiat_12\": [\n \"dolore exercitati\",\n \"aliquip laboris voluptate\"\n ],\n \"Duis_197\": [\n \"magna aliquip Ut et\",\n \"reprehenderit Excepteur ipsum\"\n ],\n \"ipsum_afb\": [\n \"aute id\",\n \"laboris exercitation irure\"\n ]\n },\n \"closed_at\": \"1989-02-23T10:17:07.627Z\",\n \"created_at\": \"1946-09-06T17:27:29.954Z\",\n \"description\": \"amet\",\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"si\",\n \"issue_key\": \"voluptate in pariatur\",\n \"issue_url\": \"tempor laborum deserunt\",\n \"project_key\": \"ipsum Duis\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"CASEM-4523\",\n \"modified_at\": \"1984-01-31T08:52:37.655Z\",\n \"priority\": \"NOT_DEFINED\",\n \"service_now_ticket\": {\n \"result\": {\n \"sys_target_link\": \"occaecat dolor officia\"\n },\n \"status\": \"COMPLETED\"\n },\n \"status\": \"OPEN\",\n \"title\": \"Memory leak investigation on API\",\n \"type\": \"STANDARD\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"title\": \"Security breach investigation\",\n \"type\": \"STANDARD\",\n \"description\": \"Duis quis magna consequat\",\n \"priority\": \"NOT_DEFINED\"\n },\n \"type\": \"case\",\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n },\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"title\": \"Security breach investigation\",\n \"type\": \"STANDARD\",\n \"description\": \"Duis quis magna consequat\",\n \"priority\": \"NOT_DEFINED\"\n },\n \"type\": \"case\",\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n },\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"title\": \"Security breach investigation\",\n \"type\": \"STANDARD\",\n \"description\": \"Duis quis magna consequat\",\n \"priority\": \"NOT_DEFINED\"\n },\n \"type\": \"case\",\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n },\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"title\": \"Security breach investigation\",\n \"type\": \"STANDARD\",\n \"description\": \"Duis quis magna consequat\",\n \"priority\": \"NOT_DEFINED\"\n },\n \"type\": \"case\",\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n },\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"title\": \"Security breach investigation\",\n \"type\": \"STANDARD\",\n \"description\": \"Duis quis magna consequat\",\n \"priority\": \"NOT_DEFINED\"\n },\n \"type\": \"case\",\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n },\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all projects",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects"
]
},
"description": "Get all projects."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"project\",\n \"attributes\": {\n \"key\": \"CASEM\",\n \"name\": \"consequat magna\"\n },\n \"relationships\": {\n \"member_team\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n },\n \"member_user\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"project\",\n \"attributes\": {\n \"key\": \"CASEM\",\n \"name\": \"eu sunt esse non aliqua\"\n },\n \"relationships\": {\n \"member_team\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n },\n \"member_user\": {\n \"data\": []\n }\n }\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get the details of a case",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id"
],
"variable": [
{
"key": "case_id",
"value": "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
}
]
},
"description": "Get the details of case by `case_id`"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2025-06-29T07:24:34.883Z\",\n \"attributes\": {\n \"in8a\": [\n \"adipisicing dolor\",\n \"esse in ex\"\n ],\n \"fugiat_12\": [\n \"dolore exercitati\",\n \"aliquip laboris voluptate\"\n ],\n \"Duis_197\": [\n \"magna aliquip Ut et\",\n \"reprehenderit Excepteur ipsum\"\n ],\n \"ipsum_afb\": [\n \"aute id\",\n \"laboris exercitation irure\"\n ]\n },\n \"closed_at\": \"1989-02-23T10:17:07.627Z\",\n \"created_at\": \"1946-09-06T17:27:29.954Z\",\n \"description\": \"amet\",\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"si\",\n \"issue_key\": \"voluptate in pariatur\",\n \"issue_url\": \"tempor laborum deserunt\",\n \"project_key\": \"ipsum Duis\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"CASEM-4523\",\n \"modified_at\": \"1984-01-31T08:52:37.655Z\",\n \"priority\": \"NOT_DEFINED\",\n \"service_now_ticket\": {\n \"result\": {\n \"sys_target_link\": \"occaecat dolor officia\"\n },\n \"status\": \"COMPLETED\"\n },\n \"status\": \"OPEN\",\n \"title\": \"Memory leak investigation on API\",\n \"type\": \"STANDARD\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get the details of a project",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects/:project_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects",
":project_id"
],
"variable": [
{
"key": "project_id",
"value": "e555e290-ed65-49bd-ae18-8acbfcf18db7"
}
]
},
"description": "Get the details of a project by `project_id`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects/:project_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects",
":project_id"
],
"variable": [
{
"key": "project_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"project\",\n \"attributes\": {\n \"key\": \"CASEM\",\n \"name\": \"veniam officia\"\n },\n \"relationships\": {\n \"member_team\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n },\n \"member_user\": {\n \"data\": []\n }\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects/:project_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects",
":project_id"
],
"variable": [
{
"key": "project_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects/:project_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects",
":project_id"
],
"variable": [
{
"key": "project_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects/:project_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects",
":project_id"
],
"variable": [
{
"key": "project_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects/:project_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects",
":project_id"
],
"variable": [
{
"key": "project_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects/:project_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects",
":project_id"
],
"variable": [
{
"key": "project_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Remove a project",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects/:project_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects",
":project_id"
],
"variable": [
{
"key": "project_id",
"value": "e555e290-ed65-49bd-ae18-8acbfcf18db7"
}
]
},
"description": "Remove a project using the project's `id`."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects/:project_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects",
":project_id"
],
"variable": [
{
"key": "project_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects/:project_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects",
":project_id"
],
"variable": [
{
"key": "project_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects/:project_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects",
":project_id"
],
"variable": [
{
"key": "project_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cases/projects/:project_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
"projects",
":project_id"
],
"variable": [
{
"key": "project_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update case status",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"status\": \"OPEN\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"status"
],
"variable": [
{
"key": "case_id",
"value": "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
}
]
},
"description": "Update case status"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"status\": \"OPEN\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"status"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2025-06-29T07:24:34.883Z\",\n \"attributes\": {\n \"in8a\": [\n \"adipisicing dolor\",\n \"esse in ex\"\n ],\n \"fugiat_12\": [\n \"dolore exercitati\",\n \"aliquip laboris voluptate\"\n ],\n \"Duis_197\": [\n \"magna aliquip Ut et\",\n \"reprehenderit Excepteur ipsum\"\n ],\n \"ipsum_afb\": [\n \"aute id\",\n \"laboris exercitation irure\"\n ]\n },\n \"closed_at\": \"1989-02-23T10:17:07.627Z\",\n \"created_at\": \"1946-09-06T17:27:29.954Z\",\n \"description\": \"amet\",\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"si\",\n \"issue_key\": \"voluptate in pariatur\",\n \"issue_url\": \"tempor laborum deserunt\",\n \"project_key\": \"ipsum Duis\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"CASEM-4523\",\n \"modified_at\": \"1984-01-31T08:52:37.655Z\",\n \"priority\": \"NOT_DEFINED\",\n \"service_now_ticket\": {\n \"result\": {\n \"sys_target_link\": \"occaecat dolor officia\"\n },\n \"status\": \"COMPLETED\"\n },\n \"status\": \"OPEN\",\n \"title\": \"Memory leak investigation on API\",\n \"type\": \"STANDARD\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"status\": \"OPEN\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"status"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"status\": \"OPEN\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"status"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"status\": \"OPEN\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"status"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"status\": \"OPEN\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"status"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"status\": \"OPEN\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"status"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update case priority",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"priority\": \"NOT_DEFINED\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/priority",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"priority"
],
"variable": [
{
"key": "case_id",
"value": "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
}
]
},
"description": "Update case priority"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"priority\": \"NOT_DEFINED\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/priority",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"priority"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2025-06-29T07:24:34.883Z\",\n \"attributes\": {\n \"in8a\": [\n \"adipisicing dolor\",\n \"esse in ex\"\n ],\n \"fugiat_12\": [\n \"dolore exercitati\",\n \"aliquip laboris voluptate\"\n ],\n \"Duis_197\": [\n \"magna aliquip Ut et\",\n \"reprehenderit Excepteur ipsum\"\n ],\n \"ipsum_afb\": [\n \"aute id\",\n \"laboris exercitation irure\"\n ]\n },\n \"closed_at\": \"1989-02-23T10:17:07.627Z\",\n \"created_at\": \"1946-09-06T17:27:29.954Z\",\n \"description\": \"amet\",\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"si\",\n \"issue_key\": \"voluptate in pariatur\",\n \"issue_url\": \"tempor laborum deserunt\",\n \"project_key\": \"ipsum Duis\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"CASEM-4523\",\n \"modified_at\": \"1984-01-31T08:52:37.655Z\",\n \"priority\": \"NOT_DEFINED\",\n \"service_now_ticket\": {\n \"result\": {\n \"sys_target_link\": \"occaecat dolor officia\"\n },\n \"status\": \"COMPLETED\"\n },\n \"status\": \"OPEN\",\n \"title\": \"Memory leak investigation on API\",\n \"type\": \"STANDARD\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"priority\": \"NOT_DEFINED\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/priority",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"priority"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"priority\": \"NOT_DEFINED\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/priority",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"priority"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"priority\": \"NOT_DEFINED\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/priority",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"priority"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"priority\": \"NOT_DEFINED\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/priority",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"priority"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"priority\": \"NOT_DEFINED\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/priority",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"priority"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Assign case",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"assignee_id\": \"f98a5a5b-e0ff-45d4-b2f5-afe6e74de504\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/assign",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"assign"
],
"variable": [
{
"key": "case_id",
"value": "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
}
]
},
"description": "Assign case to a user"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"assignee_id\": \"f98a5a5b-e0ff-45d4-b2f5-afe6e74de504\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/assign",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"assign"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2025-06-29T07:24:34.883Z\",\n \"attributes\": {\n \"in8a\": [\n \"adipisicing dolor\",\n \"esse in ex\"\n ],\n \"fugiat_12\": [\n \"dolore exercitati\",\n \"aliquip laboris voluptate\"\n ],\n \"Duis_197\": [\n \"magna aliquip Ut et\",\n \"reprehenderit Excepteur ipsum\"\n ],\n \"ipsum_afb\": [\n \"aute id\",\n \"laboris exercitation irure\"\n ]\n },\n \"closed_at\": \"1989-02-23T10:17:07.627Z\",\n \"created_at\": \"1946-09-06T17:27:29.954Z\",\n \"description\": \"amet\",\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"si\",\n \"issue_key\": \"voluptate in pariatur\",\n \"issue_url\": \"tempor laborum deserunt\",\n \"project_key\": \"ipsum Duis\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"CASEM-4523\",\n \"modified_at\": \"1984-01-31T08:52:37.655Z\",\n \"priority\": \"NOT_DEFINED\",\n \"service_now_ticket\": {\n \"result\": {\n \"sys_target_link\": \"occaecat dolor officia\"\n },\n \"status\": \"COMPLETED\"\n },\n \"status\": \"OPEN\",\n \"title\": \"Memory leak investigation on API\",\n \"type\": \"STANDARD\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"assignee_id\": \"f98a5a5b-e0ff-45d4-b2f5-afe6e74de504\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/assign",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"assign"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"assignee_id\": \"f98a5a5b-e0ff-45d4-b2f5-afe6e74de504\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/assign",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"assign"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"assignee_id\": \"f98a5a5b-e0ff-45d4-b2f5-afe6e74de504\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/assign",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"assign"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"assignee_id\": \"f98a5a5b-e0ff-45d4-b2f5-afe6e74de504\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/assign",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"assign"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"assignee_id\": \"f98a5a5b-e0ff-45d4-b2f5-afe6e74de504\"\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/assign",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"assign"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Unassign case",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/unassign",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"unassign"
],
"variable": [
{
"key": "case_id",
"value": "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
}
]
},
"description": "Unassign case"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/unassign",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"unassign"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2025-06-29T07:24:34.883Z\",\n \"attributes\": {\n \"in8a\": [\n \"adipisicing dolor\",\n \"esse in ex\"\n ],\n \"fugiat_12\": [\n \"dolore exercitati\",\n \"aliquip laboris voluptate\"\n ],\n \"Duis_197\": [\n \"magna aliquip Ut et\",\n \"reprehenderit Excepteur ipsum\"\n ],\n \"ipsum_afb\": [\n \"aute id\",\n \"laboris exercitation irure\"\n ]\n },\n \"closed_at\": \"1989-02-23T10:17:07.627Z\",\n \"created_at\": \"1946-09-06T17:27:29.954Z\",\n \"description\": \"amet\",\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"si\",\n \"issue_key\": \"voluptate in pariatur\",\n \"issue_url\": \"tempor laborum deserunt\",\n \"project_key\": \"ipsum Duis\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"CASEM-4523\",\n \"modified_at\": \"1984-01-31T08:52:37.655Z\",\n \"priority\": \"NOT_DEFINED\",\n \"service_now_ticket\": {\n \"result\": {\n \"sys_target_link\": \"occaecat dolor officia\"\n },\n \"status\": \"COMPLETED\"\n },\n \"status\": \"OPEN\",\n \"title\": \"Memory leak investigation on API\",\n \"type\": \"STANDARD\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/unassign",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"unassign"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/unassign",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"unassign"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/unassign",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"unassign"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/unassign",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"unassign"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/unassign",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"unassign"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Archive case",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/archive",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"archive"
],
"variable": [
{
"key": "case_id",
"value": "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
}
]
},
"description": "Archive case"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/archive",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"archive"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2025-06-29T07:24:34.883Z\",\n \"attributes\": {\n \"in8a\": [\n \"adipisicing dolor\",\n \"esse in ex\"\n ],\n \"fugiat_12\": [\n \"dolore exercitati\",\n \"aliquip laboris voluptate\"\n ],\n \"Duis_197\": [\n \"magna aliquip Ut et\",\n \"reprehenderit Excepteur ipsum\"\n ],\n \"ipsum_afb\": [\n \"aute id\",\n \"laboris exercitation irure\"\n ]\n },\n \"closed_at\": \"1989-02-23T10:17:07.627Z\",\n \"created_at\": \"1946-09-06T17:27:29.954Z\",\n \"description\": \"amet\",\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"si\",\n \"issue_key\": \"voluptate in pariatur\",\n \"issue_url\": \"tempor laborum deserunt\",\n \"project_key\": \"ipsum Duis\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"CASEM-4523\",\n \"modified_at\": \"1984-01-31T08:52:37.655Z\",\n \"priority\": \"NOT_DEFINED\",\n \"service_now_ticket\": {\n \"result\": {\n \"sys_target_link\": \"occaecat dolor officia\"\n },\n \"status\": \"COMPLETED\"\n },\n \"status\": \"OPEN\",\n \"title\": \"Memory leak investigation on API\",\n \"type\": \"STANDARD\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/archive",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"archive"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/archive",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"archive"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/archive",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"archive"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/archive",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"archive"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/archive",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"archive"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Unarchive case",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"unarchive"
],
"variable": [
{
"key": "case_id",
"value": "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
}
]
},
"description": "Unarchive case"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"unarchive"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2025-06-29T07:24:34.883Z\",\n \"attributes\": {\n \"in8a\": [\n \"adipisicing dolor\",\n \"esse in ex\"\n ],\n \"fugiat_12\": [\n \"dolore exercitati\",\n \"aliquip laboris voluptate\"\n ],\n \"Duis_197\": [\n \"magna aliquip Ut et\",\n \"reprehenderit Excepteur ipsum\"\n ],\n \"ipsum_afb\": [\n \"aute id\",\n \"laboris exercitation irure\"\n ]\n },\n \"closed_at\": \"1989-02-23T10:17:07.627Z\",\n \"created_at\": \"1946-09-06T17:27:29.954Z\",\n \"description\": \"amet\",\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"si\",\n \"issue_key\": \"voluptate in pariatur\",\n \"issue_url\": \"tempor laborum deserunt\",\n \"project_key\": \"ipsum Duis\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"CASEM-4523\",\n \"modified_at\": \"1984-01-31T08:52:37.655Z\",\n \"priority\": \"NOT_DEFINED\",\n \"service_now_ticket\": {\n \"result\": {\n \"sys_target_link\": \"occaecat dolor officia\"\n },\n \"status\": \"COMPLETED\"\n },\n \"status\": \"OPEN\",\n \"title\": \"Memory leak investigation on API\",\n \"type\": \"STANDARD\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"unarchive"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"unarchive"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"unarchive"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"unarchive"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"unarchive"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update case attributes",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"attributes\": {\n \"deserunt_44\": [\n \"ex ad commodo ipsum\",\n \"dolore enim sit\"\n ],\n \"in45\": [\n \"tempor proident magna\",\n \"Excepteur cillum ut consectetur\"\n ]\n }\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/attributes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"attributes"
],
"variable": [
{
"key": "case_id",
"value": "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
}
]
},
"description": "Update case attributes"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"attributes\": {\n \"deserunt_44\": [\n \"ex ad commodo ipsum\",\n \"dolore enim sit\"\n ],\n \"in45\": [\n \"tempor proident magna\",\n \"Excepteur cillum ut consectetur\"\n ]\n }\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/attributes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"attributes"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2025-06-29T07:24:34.883Z\",\n \"attributes\": {\n \"in8a\": [\n \"adipisicing dolor\",\n \"esse in ex\"\n ],\n \"fugiat_12\": [\n \"dolore exercitati\",\n \"aliquip laboris voluptate\"\n ],\n \"Duis_197\": [\n \"magna aliquip Ut et\",\n \"reprehenderit Excepteur ipsum\"\n ],\n \"ipsum_afb\": [\n \"aute id\",\n \"laboris exercitation irure\"\n ]\n },\n \"closed_at\": \"1989-02-23T10:17:07.627Z\",\n \"created_at\": \"1946-09-06T17:27:29.954Z\",\n \"description\": \"amet\",\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"si\",\n \"issue_key\": \"voluptate in pariatur\",\n \"issue_url\": \"tempor laborum deserunt\",\n \"project_key\": \"ipsum Duis\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"CASEM-4523\",\n \"modified_at\": \"1984-01-31T08:52:37.655Z\",\n \"priority\": \"NOT_DEFINED\",\n \"service_now_ticket\": {\n \"result\": {\n \"sys_target_link\": \"occaecat dolor officia\"\n },\n \"status\": \"COMPLETED\"\n },\n \"status\": \"OPEN\",\n \"title\": \"Memory leak investigation on API\",\n \"type\": \"STANDARD\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"attributes\": {\n \"deserunt_44\": [\n \"ex ad commodo ipsum\",\n \"dolore enim sit\"\n ],\n \"in45\": [\n \"tempor proident magna\",\n \"Excepteur cillum ut consectetur\"\n ]\n }\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/attributes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"attributes"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"attributes\": {\n \"deserunt_44\": [\n \"ex ad commodo ipsum\",\n \"dolore enim sit\"\n ],\n \"in45\": [\n \"tempor proident magna\",\n \"Excepteur cillum ut consectetur\"\n ]\n }\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/attributes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"attributes"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"attributes\": {\n \"deserunt_44\": [\n \"ex ad commodo ipsum\",\n \"dolore enim sit\"\n ],\n \"in45\": [\n \"tempor proident magna\",\n \"Excepteur cillum ut consectetur\"\n ]\n }\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/attributes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"attributes"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"attributes\": {\n \"deserunt_44\": [\n \"ex ad commodo ipsum\",\n \"dolore enim sit\"\n ],\n \"in45\": [\n \"tempor proident magna\",\n \"Excepteur cillum ut consectetur\"\n ]\n }\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/attributes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"attributes"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"attributes\": {\n \"deserunt_44\": [\n \"ex ad commodo ipsum\",\n \"dolore enim sit\"\n ],\n \"in45\": [\n \"tempor proident magna\",\n \"Excepteur cillum ut consectetur\"\n ]\n }\n },\n \"type\": \"case\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cases/:case_id/attributes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cases",
":case_id",
"attributes"
],
"variable": [
{
"key": "case_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "View and manage cases and projects within Case Management. See the [Case Management page](https://docs.datadoghq.com/service_management/case_management/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "CI Visibility Pipelines",
"item": [
{
"name": "Send pipeline event",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource\": {\n \"level\": \"pipeline\",\n \"unique_id\": \"3eacb6f3-ff04-4e10-8a9c-46e6d054024a\",\n \"name\": \"Deploy to AWS\",\n \"url\": \"https://my-ci-provider.example/pipelines/my-pipeline/run/1\",\n \"start\": \"2023-05-31T15:30:00Z\",\n \"end\": \"2023-05-31T15:30:00Z\",\n \"status\": \"success\",\n \"partial_retry\": false,\n \"error\": {\n \"domain\": \"user\",\n \"message\": \"minim sunt \",\n \"stack\": \"pariatur tempor dolore Excepteur\",\n \"type\": \"ut\"\n },\n \"git\": {\n \"repository_url\": \"https://github.com/username/repository\",\n \"sha\": \"da39a3ee5e6b4b0d3255bfef95601890afd80709\",\n \"author_email\": \"author@example.com\",\n \"author_name\": \"John Doe\",\n \"author_time\": \"2023-05-31T15:30:00Z\",\n \"branch\": \"feature-1\",\n \"commit_time\": \"2023-05-31T15:30:00Z\",\n \"committer_email\": \"committer@example.com\",\n \"committer_name\": \"ut Lorem non id velit\",\n \"default_branch\": \"main\",\n \"message\": \"Instrumenting tests with CI Visibility.\",\n \"tag\": \"v1.0.0\"\n },\n \"is_manual\": false,\n \"is_resumed\": false,\n \"metrics\": [\n \"bundle_size:370\",\n \"build_time:50021\"\n ],\n \"node\": {\n \"hostname\": \"www.example.com\",\n \"labels\": [\n \"ubuntu-18.04\",\n \"n2.large\"\n ],\n \"name\": \"Ut enim commodo do\",\n \"workspace\": \"/home/workspace/code/my-repo\"\n },\n \"parameters\": {\n \"LOG_LEVEL\": \"debug\"\n },\n \"parent_pipeline\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"pipeline_id\": \"#023\",\n \"previous_attempt\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"queue_time\": 1004,\n \"tags\": [\n \"team:backend\",\n \"type:deployment\"\n ]\n },\n \"env\": \"non incididunt\",\n \"service\": \"non do incididunt fugiat\"\n },\n \"type\": \"cipipeline_resource_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipeline",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipeline"
]
},
"description": "Send your pipeline event to your Datadog platform over HTTP. For details about how pipeline executions are modeled and what execution types we support, see [Pipeline Data Model And Execution Types](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/).\n\nPipeline events can be submitted with a timestamp that is up to 18 hours in the past."
},
"response": [
{
"name": "Request accepted for processing",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource\": {\n \"level\": \"pipeline\",\n \"unique_id\": \"3eacb6f3-ff04-4e10-8a9c-46e6d054024a\",\n \"name\": \"Deploy to AWS\",\n \"url\": \"https://my-ci-provider.example/pipelines/my-pipeline/run/1\",\n \"start\": \"2023-05-31T15:30:00Z\",\n \"end\": \"2023-05-31T15:30:00Z\",\n \"status\": \"success\",\n \"partial_retry\": false,\n \"error\": {\n \"domain\": \"user\",\n \"message\": \"minim sunt \",\n \"stack\": \"pariatur tempor dolore Excepteur\",\n \"type\": \"ut\"\n },\n \"git\": {\n \"repository_url\": \"https://github.com/username/repository\",\n \"sha\": \"da39a3ee5e6b4b0d3255bfef95601890afd80709\",\n \"author_email\": \"author@example.com\",\n \"author_name\": \"John Doe\",\n \"author_time\": \"2023-05-31T15:30:00Z\",\n \"branch\": \"feature-1\",\n \"commit_time\": \"2023-05-31T15:30:00Z\",\n \"committer_email\": \"committer@example.com\",\n \"committer_name\": \"ut Lorem non id velit\",\n \"default_branch\": \"main\",\n \"message\": \"Instrumenting tests with CI Visibility.\",\n \"tag\": \"v1.0.0\"\n },\n \"is_manual\": false,\n \"is_resumed\": false,\n \"metrics\": [\n \"bundle_size:370\",\n \"build_time:50021\"\n ],\n \"node\": {\n \"hostname\": \"www.example.com\",\n \"labels\": [\n \"ubuntu-18.04\",\n \"n2.large\"\n ],\n \"name\": \"Ut enim commodo do\",\n \"workspace\": \"/home/workspace/code/my-repo\"\n },\n \"parameters\": {\n \"LOG_LEVEL\": \"debug\"\n },\n \"parent_pipeline\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"pipeline_id\": \"#023\",\n \"previous_attempt\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"queue_time\": 1004,\n \"tags\": [\n \"team:backend\",\n \"type:deployment\"\n ]\n },\n \"env\": \"non incididunt\",\n \"service\": \"non do incididunt fugiat\"\n },\n \"type\": \"cipipeline_resource_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipeline",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipeline"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource\": {\n \"level\": \"pipeline\",\n \"unique_id\": \"3eacb6f3-ff04-4e10-8a9c-46e6d054024a\",\n \"name\": \"Deploy to AWS\",\n \"url\": \"https://my-ci-provider.example/pipelines/my-pipeline/run/1\",\n \"start\": \"2023-05-31T15:30:00Z\",\n \"end\": \"2023-05-31T15:30:00Z\",\n \"status\": \"success\",\n \"partial_retry\": false,\n \"error\": {\n \"domain\": \"user\",\n \"message\": \"minim sunt \",\n \"stack\": \"pariatur tempor dolore Excepteur\",\n \"type\": \"ut\"\n },\n \"git\": {\n \"repository_url\": \"https://github.com/username/repository\",\n \"sha\": \"da39a3ee5e6b4b0d3255bfef95601890afd80709\",\n \"author_email\": \"author@example.com\",\n \"author_name\": \"John Doe\",\n \"author_time\": \"2023-05-31T15:30:00Z\",\n \"branch\": \"feature-1\",\n \"commit_time\": \"2023-05-31T15:30:00Z\",\n \"committer_email\": \"committer@example.com\",\n \"committer_name\": \"ut Lorem non id velit\",\n \"default_branch\": \"main\",\n \"message\": \"Instrumenting tests with CI Visibility.\",\n \"tag\": \"v1.0.0\"\n },\n \"is_manual\": false,\n \"is_resumed\": false,\n \"metrics\": [\n \"bundle_size:370\",\n \"build_time:50021\"\n ],\n \"node\": {\n \"hostname\": \"www.example.com\",\n \"labels\": [\n \"ubuntu-18.04\",\n \"n2.large\"\n ],\n \"name\": \"Ut enim commodo do\",\n \"workspace\": \"/home/workspace/code/my-repo\"\n },\n \"parameters\": {\n \"LOG_LEVEL\": \"debug\"\n },\n \"parent_pipeline\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"pipeline_id\": \"#023\",\n \"previous_attempt\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"queue_time\": 1004,\n \"tags\": [\n \"team:backend\",\n \"type:deployment\"\n ]\n },\n \"env\": \"non incididunt\",\n \"service\": \"non do incididunt fugiat\"\n },\n \"type\": \"cipipeline_resource_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipeline",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipeline"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource\": {\n \"level\": \"pipeline\",\n \"unique_id\": \"3eacb6f3-ff04-4e10-8a9c-46e6d054024a\",\n \"name\": \"Deploy to AWS\",\n \"url\": \"https://my-ci-provider.example/pipelines/my-pipeline/run/1\",\n \"start\": \"2023-05-31T15:30:00Z\",\n \"end\": \"2023-05-31T15:30:00Z\",\n \"status\": \"success\",\n \"partial_retry\": false,\n \"error\": {\n \"domain\": \"user\",\n \"message\": \"minim sunt \",\n \"stack\": \"pariatur tempor dolore Excepteur\",\n \"type\": \"ut\"\n },\n \"git\": {\n \"repository_url\": \"https://github.com/username/repository\",\n \"sha\": \"da39a3ee5e6b4b0d3255bfef95601890afd80709\",\n \"author_email\": \"author@example.com\",\n \"author_name\": \"John Doe\",\n \"author_time\": \"2023-05-31T15:30:00Z\",\n \"branch\": \"feature-1\",\n \"commit_time\": \"2023-05-31T15:30:00Z\",\n \"committer_email\": \"committer@example.com\",\n \"committer_name\": \"ut Lorem non id velit\",\n \"default_branch\": \"main\",\n \"message\": \"Instrumenting tests with CI Visibility.\",\n \"tag\": \"v1.0.0\"\n },\n \"is_manual\": false,\n \"is_resumed\": false,\n \"metrics\": [\n \"bundle_size:370\",\n \"build_time:50021\"\n ],\n \"node\": {\n \"hostname\": \"www.example.com\",\n \"labels\": [\n \"ubuntu-18.04\",\n \"n2.large\"\n ],\n \"name\": \"Ut enim commodo do\",\n \"workspace\": \"/home/workspace/code/my-repo\"\n },\n \"parameters\": {\n \"LOG_LEVEL\": \"debug\"\n },\n \"parent_pipeline\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"pipeline_id\": \"#023\",\n \"previous_attempt\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"queue_time\": 1004,\n \"tags\": [\n \"team:backend\",\n \"type:deployment\"\n ]\n },\n \"env\": \"non incididunt\",\n \"service\": \"non do incididunt fugiat\"\n },\n \"type\": \"cipipeline_resource_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipeline",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipeline"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource\": {\n \"level\": \"pipeline\",\n \"unique_id\": \"3eacb6f3-ff04-4e10-8a9c-46e6d054024a\",\n \"name\": \"Deploy to AWS\",\n \"url\": \"https://my-ci-provider.example/pipelines/my-pipeline/run/1\",\n \"start\": \"2023-05-31T15:30:00Z\",\n \"end\": \"2023-05-31T15:30:00Z\",\n \"status\": \"success\",\n \"partial_retry\": false,\n \"error\": {\n \"domain\": \"user\",\n \"message\": \"minim sunt \",\n \"stack\": \"pariatur tempor dolore Excepteur\",\n \"type\": \"ut\"\n },\n \"git\": {\n \"repository_url\": \"https://github.com/username/repository\",\n \"sha\": \"da39a3ee5e6b4b0d3255bfef95601890afd80709\",\n \"author_email\": \"author@example.com\",\n \"author_name\": \"John Doe\",\n \"author_time\": \"2023-05-31T15:30:00Z\",\n \"branch\": \"feature-1\",\n \"commit_time\": \"2023-05-31T15:30:00Z\",\n \"committer_email\": \"committer@example.com\",\n \"committer_name\": \"ut Lorem non id velit\",\n \"default_branch\": \"main\",\n \"message\": \"Instrumenting tests with CI Visibility.\",\n \"tag\": \"v1.0.0\"\n },\n \"is_manual\": false,\n \"is_resumed\": false,\n \"metrics\": [\n \"bundle_size:370\",\n \"build_time:50021\"\n ],\n \"node\": {\n \"hostname\": \"www.example.com\",\n \"labels\": [\n \"ubuntu-18.04\",\n \"n2.large\"\n ],\n \"name\": \"Ut enim commodo do\",\n \"workspace\": \"/home/workspace/code/my-repo\"\n },\n \"parameters\": {\n \"LOG_LEVEL\": \"debug\"\n },\n \"parent_pipeline\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"pipeline_id\": \"#023\",\n \"previous_attempt\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"queue_time\": 1004,\n \"tags\": [\n \"team:backend\",\n \"type:deployment\"\n ]\n },\n \"env\": \"non incididunt\",\n \"service\": \"non do incididunt fugiat\"\n },\n \"type\": \"cipipeline_resource_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipeline",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipeline"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Request Timeout",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource\": {\n \"level\": \"pipeline\",\n \"unique_id\": \"3eacb6f3-ff04-4e10-8a9c-46e6d054024a\",\n \"name\": \"Deploy to AWS\",\n \"url\": \"https://my-ci-provider.example/pipelines/my-pipeline/run/1\",\n \"start\": \"2023-05-31T15:30:00Z\",\n \"end\": \"2023-05-31T15:30:00Z\",\n \"status\": \"success\",\n \"partial_retry\": false,\n \"error\": {\n \"domain\": \"user\",\n \"message\": \"minim sunt \",\n \"stack\": \"pariatur tempor dolore Excepteur\",\n \"type\": \"ut\"\n },\n \"git\": {\n \"repository_url\": \"https://github.com/username/repository\",\n \"sha\": \"da39a3ee5e6b4b0d3255bfef95601890afd80709\",\n \"author_email\": \"author@example.com\",\n \"author_name\": \"John Doe\",\n \"author_time\": \"2023-05-31T15:30:00Z\",\n \"branch\": \"feature-1\",\n \"commit_time\": \"2023-05-31T15:30:00Z\",\n \"committer_email\": \"committer@example.com\",\n \"committer_name\": \"ut Lorem non id velit\",\n \"default_branch\": \"main\",\n \"message\": \"Instrumenting tests with CI Visibility.\",\n \"tag\": \"v1.0.0\"\n },\n \"is_manual\": false,\n \"is_resumed\": false,\n \"metrics\": [\n \"bundle_size:370\",\n \"build_time:50021\"\n ],\n \"node\": {\n \"hostname\": \"www.example.com\",\n \"labels\": [\n \"ubuntu-18.04\",\n \"n2.large\"\n ],\n \"name\": \"Ut enim commodo do\",\n \"workspace\": \"/home/workspace/code/my-repo\"\n },\n \"parameters\": {\n \"LOG_LEVEL\": \"debug\"\n },\n \"parent_pipeline\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"pipeline_id\": \"#023\",\n \"previous_attempt\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"queue_time\": 1004,\n \"tags\": [\n \"team:backend\",\n \"type:deployment\"\n ]\n },\n \"env\": \"non incididunt\",\n \"service\": \"non do incididunt fugiat\"\n },\n \"type\": \"cipipeline_resource_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipeline",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipeline"
]
}
},
"status": "Request Timeout",
"code": 408,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Payload Too Large",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource\": {\n \"level\": \"pipeline\",\n \"unique_id\": \"3eacb6f3-ff04-4e10-8a9c-46e6d054024a\",\n \"name\": \"Deploy to AWS\",\n \"url\": \"https://my-ci-provider.example/pipelines/my-pipeline/run/1\",\n \"start\": \"2023-05-31T15:30:00Z\",\n \"end\": \"2023-05-31T15:30:00Z\",\n \"status\": \"success\",\n \"partial_retry\": false,\n \"error\": {\n \"domain\": \"user\",\n \"message\": \"minim sunt \",\n \"stack\": \"pariatur tempor dolore Excepteur\",\n \"type\": \"ut\"\n },\n \"git\": {\n \"repository_url\": \"https://github.com/username/repository\",\n \"sha\": \"da39a3ee5e6b4b0d3255bfef95601890afd80709\",\n \"author_email\": \"author@example.com\",\n \"author_name\": \"John Doe\",\n \"author_time\": \"2023-05-31T15:30:00Z\",\n \"branch\": \"feature-1\",\n \"commit_time\": \"2023-05-31T15:30:00Z\",\n \"committer_email\": \"committer@example.com\",\n \"committer_name\": \"ut Lorem non id velit\",\n \"default_branch\": \"main\",\n \"message\": \"Instrumenting tests with CI Visibility.\",\n \"tag\": \"v1.0.0\"\n },\n \"is_manual\": false,\n \"is_resumed\": false,\n \"metrics\": [\n \"bundle_size:370\",\n \"build_time:50021\"\n ],\n \"node\": {\n \"hostname\": \"www.example.com\",\n \"labels\": [\n \"ubuntu-18.04\",\n \"n2.large\"\n ],\n \"name\": \"Ut enim commodo do\",\n \"workspace\": \"/home/workspace/code/my-repo\"\n },\n \"parameters\": {\n \"LOG_LEVEL\": \"debug\"\n },\n \"parent_pipeline\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"pipeline_id\": \"#023\",\n \"previous_attempt\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"queue_time\": 1004,\n \"tags\": [\n \"team:backend\",\n \"type:deployment\"\n ]\n },\n \"env\": \"non incididunt\",\n \"service\": \"non do incididunt fugiat\"\n },\n \"type\": \"cipipeline_resource_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipeline",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipeline"
]
}
},
"status": "Request Entity Too Large",
"code": 413,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource\": {\n \"level\": \"pipeline\",\n \"unique_id\": \"3eacb6f3-ff04-4e10-8a9c-46e6d054024a\",\n \"name\": \"Deploy to AWS\",\n \"url\": \"https://my-ci-provider.example/pipelines/my-pipeline/run/1\",\n \"start\": \"2023-05-31T15:30:00Z\",\n \"end\": \"2023-05-31T15:30:00Z\",\n \"status\": \"success\",\n \"partial_retry\": false,\n \"error\": {\n \"domain\": \"user\",\n \"message\": \"minim sunt \",\n \"stack\": \"pariatur tempor dolore Excepteur\",\n \"type\": \"ut\"\n },\n \"git\": {\n \"repository_url\": \"https://github.com/username/repository\",\n \"sha\": \"da39a3ee5e6b4b0d3255bfef95601890afd80709\",\n \"author_email\": \"author@example.com\",\n \"author_name\": \"John Doe\",\n \"author_time\": \"2023-05-31T15:30:00Z\",\n \"branch\": \"feature-1\",\n \"commit_time\": \"2023-05-31T15:30:00Z\",\n \"committer_email\": \"committer@example.com\",\n \"committer_name\": \"ut Lorem non id velit\",\n \"default_branch\": \"main\",\n \"message\": \"Instrumenting tests with CI Visibility.\",\n \"tag\": \"v1.0.0\"\n },\n \"is_manual\": false,\n \"is_resumed\": false,\n \"metrics\": [\n \"bundle_size:370\",\n \"build_time:50021\"\n ],\n \"node\": {\n \"hostname\": \"www.example.com\",\n \"labels\": [\n \"ubuntu-18.04\",\n \"n2.large\"\n ],\n \"name\": \"Ut enim commodo do\",\n \"workspace\": \"/home/workspace/code/my-repo\"\n },\n \"parameters\": {\n \"LOG_LEVEL\": \"debug\"\n },\n \"parent_pipeline\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"pipeline_id\": \"#023\",\n \"previous_attempt\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"queue_time\": 1004,\n \"tags\": [\n \"team:backend\",\n \"type:deployment\"\n ]\n },\n \"env\": \"non incididunt\",\n \"service\": \"non do incididunt fugiat\"\n },\n \"type\": \"cipipeline_resource_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipeline",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipeline"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Internal Server Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource\": {\n \"level\": \"pipeline\",\n \"unique_id\": \"3eacb6f3-ff04-4e10-8a9c-46e6d054024a\",\n \"name\": \"Deploy to AWS\",\n \"url\": \"https://my-ci-provider.example/pipelines/my-pipeline/run/1\",\n \"start\": \"2023-05-31T15:30:00Z\",\n \"end\": \"2023-05-31T15:30:00Z\",\n \"status\": \"success\",\n \"partial_retry\": false,\n \"error\": {\n \"domain\": \"user\",\n \"message\": \"minim sunt \",\n \"stack\": \"pariatur tempor dolore Excepteur\",\n \"type\": \"ut\"\n },\n \"git\": {\n \"repository_url\": \"https://github.com/username/repository\",\n \"sha\": \"da39a3ee5e6b4b0d3255bfef95601890afd80709\",\n \"author_email\": \"author@example.com\",\n \"author_name\": \"John Doe\",\n \"author_time\": \"2023-05-31T15:30:00Z\",\n \"branch\": \"feature-1\",\n \"commit_time\": \"2023-05-31T15:30:00Z\",\n \"committer_email\": \"committer@example.com\",\n \"committer_name\": \"ut Lorem non id velit\",\n \"default_branch\": \"main\",\n \"message\": \"Instrumenting tests with CI Visibility.\",\n \"tag\": \"v1.0.0\"\n },\n \"is_manual\": false,\n \"is_resumed\": false,\n \"metrics\": [\n \"bundle_size:370\",\n \"build_time:50021\"\n ],\n \"node\": {\n \"hostname\": \"www.example.com\",\n \"labels\": [\n \"ubuntu-18.04\",\n \"n2.large\"\n ],\n \"name\": \"Ut enim commodo do\",\n \"workspace\": \"/home/workspace/code/my-repo\"\n },\n \"parameters\": {\n \"LOG_LEVEL\": \"debug\"\n },\n \"parent_pipeline\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"pipeline_id\": \"#023\",\n \"previous_attempt\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"queue_time\": 1004,\n \"tags\": [\n \"team:backend\",\n \"type:deployment\"\n ]\n },\n \"env\": \"non incididunt\",\n \"service\": \"non do incididunt fugiat\"\n },\n \"type\": \"cipipeline_resource_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipeline",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipeline"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Service Unavailable",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource\": {\n \"level\": \"pipeline\",\n \"unique_id\": \"3eacb6f3-ff04-4e10-8a9c-46e6d054024a\",\n \"name\": \"Deploy to AWS\",\n \"url\": \"https://my-ci-provider.example/pipelines/my-pipeline/run/1\",\n \"start\": \"2023-05-31T15:30:00Z\",\n \"end\": \"2023-05-31T15:30:00Z\",\n \"status\": \"success\",\n \"partial_retry\": false,\n \"error\": {\n \"domain\": \"user\",\n \"message\": \"minim sunt \",\n \"stack\": \"pariatur tempor dolore Excepteur\",\n \"type\": \"ut\"\n },\n \"git\": {\n \"repository_url\": \"https://github.com/username/repository\",\n \"sha\": \"da39a3ee5e6b4b0d3255bfef95601890afd80709\",\n \"author_email\": \"author@example.com\",\n \"author_name\": \"John Doe\",\n \"author_time\": \"2023-05-31T15:30:00Z\",\n \"branch\": \"feature-1\",\n \"commit_time\": \"2023-05-31T15:30:00Z\",\n \"committer_email\": \"committer@example.com\",\n \"committer_name\": \"ut Lorem non id velit\",\n \"default_branch\": \"main\",\n \"message\": \"Instrumenting tests with CI Visibility.\",\n \"tag\": \"v1.0.0\"\n },\n \"is_manual\": false,\n \"is_resumed\": false,\n \"metrics\": [\n \"bundle_size:370\",\n \"build_time:50021\"\n ],\n \"node\": {\n \"hostname\": \"www.example.com\",\n \"labels\": [\n \"ubuntu-18.04\",\n \"n2.large\"\n ],\n \"name\": \"Ut enim commodo do\",\n \"workspace\": \"/home/workspace/code/my-repo\"\n },\n \"parameters\": {\n \"LOG_LEVEL\": \"debug\"\n },\n \"parent_pipeline\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"pipeline_id\": \"#023\",\n \"previous_attempt\": {\n \"id\": \"93bfeb70-af47-424d-908a-948d3f08e37f\",\n \"url\": \"https://ci-platform.com/pipelines/123456789\"\n },\n \"queue_time\": 1004,\n \"tags\": [\n \"team:backend\",\n \"type:deployment\"\n ]\n },\n \"env\": \"non incididunt\",\n \"service\": \"non do incididunt fugiat\"\n },\n \"type\": \"cipipeline_resource_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipeline",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipeline"
]
}
},
"status": "Service Unavailable",
"code": 503,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
},
{
"name": "Get a list of pipelines events",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@ci.provider.name:github @ci.pipeline.name:Pull Request Labeler",
"description": "Search query following log syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
},
"description": "List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to see your latest pipeline events."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@ci.provider.name:github @ci.pipeline.name:Pull Request Labeler",
"description": "Search query following log syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"ci_level\": \"pipeline\",\n \"tags\": [\n \"team:A\"\n ]\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"cipipeline\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"ci_level\": \"pipeline\",\n \"tags\": [\n \"team:A\"\n ]\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"cipipeline\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/ci/tests/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@ci.provider.name:github @ci.pipeline.name:Pull Request Labeler",
"description": "Search query following log syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@ci.provider.name:github @ci.pipeline.name:Pull Request Labeler",
"description": "Search query following log syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@ci.provider.name:github @ci.pipeline.name:Pull Request Labeler",
"description": "Search query following log syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Search pipelines events",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@ci.provider.name:github AND @ci.status:error\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": 49743317,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"events",
"search"
]
},
"description": "List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to build complex events filtering and search."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@ci.provider.name:github AND @ci.status:error\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": 49743317,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"events",
"search"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"ci_level\": \"pipeline\",\n \"tags\": [\n \"team:A\"\n ]\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"cipipeline\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"ci_level\": \"pipeline\",\n \"tags\": [\n \"team:A\"\n ]\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"cipipeline\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/ci/tests/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@ci.provider.name:github AND @ci.status:error\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": 49743317,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"events",
"search"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@ci.provider.name:github AND @ci.status:error\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": 49743317,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"events",
"search"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@ci.provider.name:github AND @ci.status:error\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": 49743317,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"events",
"search"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Aggregate pipelines events",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@ci.provider.name:github AND @ci.status:error\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"@ci.status\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"quis occaecat Duis\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n },\n {\n \"facet\": \"@ci.status\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"ut elit ex\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n }\n ],\n \"options\": {\n \"time_offset\": -19067111,\n \"timezone\": \"GMT\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"analytics",
"aggregate"
]
},
"description": "Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@ci.provider.name:github AND @ci.status:error\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"@ci.status\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"quis occaecat Duis\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n },\n {\n \"facet\": \"@ci.status\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"ut elit ex\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n }\n ],\n \"options\": {\n \"time_offset\": -19067111,\n \"timezone\": \"GMT\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"analytics",
"aggregate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"buckets\": [\n {\n \"by\": {\n \"@ci.provider.name\": \"gitlab\",\n \"@ci.status\": \"success\"\n },\n \"computes\": {\n \"incididunt_27\": \"eu do velit\"\n }\n },\n {\n \"by\": {\n \"@ci.provider.name\": \"gitlab\",\n \"@ci.status\": \"success\"\n },\n \"computes\": {\n \"quisb\": \"culpa aliquip ullamco laborum\"\n }\n }\n ]\n },\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/ci/tests/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@ci.provider.name:github AND @ci.status:error\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"@ci.status\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"quis occaecat Duis\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n },\n {\n \"facet\": \"@ci.status\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"ut elit ex\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n }\n ],\n \"options\": {\n \"time_offset\": -19067111,\n \"timezone\": \"GMT\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"analytics",
"aggregate"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@ci.provider.name:github AND @ci.status:error\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"@ci.status\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"quis occaecat Duis\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n },\n {\n \"facet\": \"@ci.status\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"ut elit ex\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n }\n ],\n \"options\": {\n \"time_offset\": -19067111,\n \"timezone\": \"GMT\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"analytics",
"aggregate"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@ci.provider.name:github AND @ci.status:error\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"@ci.status\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"quis occaecat Duis\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n },\n {\n \"facet\": \"@ci.status\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"ut elit ex\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n }\n ],\n \"options\": {\n \"time_offset\": -19067111,\n \"timezone\": \"GMT\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"analytics",
"aggregate"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Search or aggregate your CI Visibility pipeline events and send them to your Datadog site over HTTP. See the [CI Pipeline Visibility in Datadog page](https://docs.datadoghq.com/continuous_integration/pipelines/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "CI Visibility Tests",
"item": [
{
"name": "Get a list of tests events",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ci/tests/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"tests",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@test.name:test_foo @test.suite:github.com/DataDog/dd-go/model",
"description": "Search query following log syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
},
"description": "List endpoint returns CI Visibility test events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to see your latest test events."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ci/tests/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"tests",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@test.name:test_foo @test.suite:github.com/DataDog/dd-go/model",
"description": "Search query following log syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"tags\": [\n \"team:A\"\n ],\n \"test_level\": \"test\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"citest\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"tags\": [\n \"team:A\"\n ],\n \"test_level\": \"test\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"citest\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/ci/tests/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ci/tests/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"tests",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@test.name:test_foo @test.suite:github.com/DataDog/dd-go/model",
"description": "Search query following log syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ci/tests/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"tests",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@test.name:test_foo @test.suite:github.com/DataDog/dd-go/model",
"description": "Search query following log syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ci/tests/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"tests",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@test.name:test_foo @test.suite:github.com/DataDog/dd-go/model",
"description": "Search query following log syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Search tests events",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@test.service:web-ui-tests AND @test.status:fail\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": -15428975,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/tests/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"tests",
"events",
"search"
]
},
"description": "List endpoint returns CI Visibility test events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to build complex events filtering and search."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@test.service:web-ui-tests AND @test.status:fail\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": -15428975,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/tests/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"tests",
"events",
"search"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"tags\": [\n \"team:A\"\n ],\n \"test_level\": \"test\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"citest\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"tags\": [\n \"team:A\"\n ],\n \"test_level\": \"test\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"citest\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/ci/tests/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@test.service:web-ui-tests AND @test.status:fail\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": -15428975,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/tests/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"tests",
"events",
"search"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@test.service:web-ui-tests AND @test.status:fail\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": -15428975,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/tests/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"tests",
"events",
"search"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@test.service:web-ui-tests AND @test.status:fail\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": -15428975,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/tests/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"tests",
"events",
"search"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Aggregate tests events",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@test.service:web-ui-tests AND @test.status:fail\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"@test.service\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"aliquip occaecat mollit labore eiusmod\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n },\n {\n \"facet\": \"@test.service\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"sint\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n }\n ],\n \"options\": {\n \"time_offset\": -86649455,\n \"timezone\": \"GMT\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/tests/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"tests",
"analytics",
"aggregate"
]
},
"description": "The API endpoint to aggregate CI Visibility test events into buckets of computed metrics and timeseries."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@test.service:web-ui-tests AND @test.status:fail\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"@test.service\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"aliquip occaecat mollit labore eiusmod\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n },\n {\n \"facet\": \"@test.service\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"sint\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n }\n ],\n \"options\": {\n \"time_offset\": -86649455,\n \"timezone\": \"GMT\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/tests/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"tests",
"analytics",
"aggregate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"buckets\": [\n {\n \"by\": {\n \"@test.service\": \"web-ui-tests\",\n \"@test.status\": \"skip\"\n },\n \"computes\": {\n \"proident__7\": \"sit enim incididunt minim laboris\",\n \"aliqua_45\": \"consectetur do consequat\"\n }\n },\n {\n \"by\": {\n \"@test.service\": \"web-ui-tests\",\n \"@test.status\": \"skip\"\n },\n \"computes\": {\n \"et_c\": \"aliqua ea aliquip occaecat labore\",\n \"dolorec4\": \"non\"\n }\n }\n ]\n },\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/ci/tests/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@test.service:web-ui-tests AND @test.status:fail\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"@test.service\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"aliquip occaecat mollit labore eiusmod\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n },\n {\n \"facet\": \"@test.service\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"sint\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n }\n ],\n \"options\": {\n \"time_offset\": -86649455,\n \"timezone\": \"GMT\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/tests/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"tests",
"analytics",
"aggregate"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@test.service:web-ui-tests AND @test.status:fail\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"@test.service\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"aliquip occaecat mollit labore eiusmod\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n },\n {\n \"facet\": \"@test.service\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"sint\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n }\n ],\n \"options\": {\n \"time_offset\": -86649455,\n \"timezone\": \"GMT\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/tests/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"tests",
"analytics",
"aggregate"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@test.service:web-ui-tests AND @test.status:fail\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"@test.service\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"aliquip occaecat mollit labore eiusmod\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n },\n {\n \"facet\": \"@test.service\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"sint\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n }\n ],\n \"options\": {\n \"time_offset\": -86649455,\n \"timezone\": \"GMT\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/tests/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"tests",
"analytics",
"aggregate"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Search or aggregate your CI Visibility test events over HTTP. See the [Test Visibility in Datadog page](https://docs.datadoghq.com/tests/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Cloud Cost Management",
"item": [
{
"name": "List Cloud Cost Management AWS CUR configs",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config"
]
},
"description": "List the AWS CUR configs."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"account_id\": \"123456789123\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"bucket_region\": \"us-east-1\",\n \"report_name\": \"dd-report-name\",\n \"report_prefix\": \"dd-report-prefix\",\n \"status\": \"active\",\n \"account_filters\": {\n \"excluded_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ],\n \"include_new_accounts\": true,\n \"included_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ]\n },\n \"created_at\": \"6437-60-83T44:82:66\\\\155262\",\n \"error_messages\": [\n \"Excepteur\",\n \"irure sit\"\n ],\n \"status_updated_at\": \"5489-86-81T19:38:83%213322\",\n \"updated_at\": \"6845-96-76T44:16:91s233777\"\n },\n \"type\": \"aws_cur_config\",\n \"id\": 47060420\n },\n {\n \"attributes\": {\n \"account_id\": \"123456789123\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"bucket_region\": \"us-east-1\",\n \"report_name\": \"dd-report-name\",\n \"report_prefix\": \"dd-report-prefix\",\n \"status\": \"active\",\n \"account_filters\": {\n \"excluded_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ],\n \"include_new_accounts\": true,\n \"included_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ]\n },\n \"created_at\": \"0337-10-80T94:88:89J718985\",\n \"error_messages\": [\n \"cillum labore aute et\",\n \"in aliquip qui est\"\n ],\n \"status_updated_at\": \"5468-35-20T51:62:68.018511\",\n \"updated_at\": \"5179-83-70T07:74:17/218238\"\n },\n \"type\": \"aws_cur_config\",\n \"id\": -42009360\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List Cloud Cost Management GCP Usage Cost configs",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config"
]
},
"description": "List the GCP Usage Cost configs."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"account_id\": \"123456_A123BC_12AB34\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"dataset\": \"billing\",\n \"export_prefix\": \"datadog_cloud_cost_usage_export\",\n \"export_project_name\": \"dd-cloud-cost-report\",\n \"service_account\": \"dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com\",\n \"status\": \"active\",\n \"created_at\": \"4512-98-83T57:42:42~502229\",\n \"error_messages\": [\n \"nisi dolor\",\n \"veniam\"\n ],\n \"project_id\": \"my-project-123\",\n \"status_updated_at\": \"1096-50-36T16:93:43 573590\",\n \"updated_at\": \"1696-09-31T79:61:10S782046\"\n },\n \"type\": \"gcp_uc_config\",\n \"id\": \"mollit sed dolor laborum\"\n },\n {\n \"attributes\": {\n \"account_id\": \"123456_A123BC_12AB34\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"dataset\": \"billing\",\n \"export_prefix\": \"datadog_cloud_cost_usage_export\",\n \"export_project_name\": \"dd-cloud-cost-report\",\n \"service_account\": \"dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com\",\n \"status\": \"active\",\n \"created_at\": \"7100-16-45T66:82:69n741205\",\n \"error_messages\": [\n \"incididunt non officia velit\",\n \"nostr\"\n ],\n \"project_id\": \"my-project-123\",\n \"status_updated_at\": \"6394-81-68T12:49:23>736004\",\n \"updated_at\": \"4966-37-25T06:38:754098714\"\n },\n \"type\": \"gcp_uc_config\",\n \"id\": \"sit ut ea ullamco\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update Cloud Cost Management AWS CUR config",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_filters\": {\n \"excluded_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ],\n \"include_new_accounts\": true,\n \"included_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ]\n },\n \"is_enabled\": true\n },\n \"type\": \"aws_cur_config_patch_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id",
"value": "proident amet voluptate"
}
]
},
"description": "Update the status (active/archived) and/or account filtering configuration of an AWS CUR config."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_filters\": {\n \"excluded_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ],\n \"include_new_accounts\": true,\n \"included_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ]\n },\n \"is_enabled\": true\n },\n \"type\": \"aws_cur_config_patch_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"account_id\": \"123456789123\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"bucket_region\": \"us-east-1\",\n \"report_name\": \"dd-report-name\",\n \"report_prefix\": \"dd-report-prefix\",\n \"status\": \"active\",\n \"account_filters\": {\n \"excluded_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ],\n \"include_new_accounts\": true,\n \"included_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ]\n },\n \"created_at\": \"6437-60-83T44:82:66\\\\155262\",\n \"error_messages\": [\n \"Excepteur\",\n \"irure sit\"\n ],\n \"status_updated_at\": \"5489-86-81T19:38:83%213322\",\n \"updated_at\": \"6845-96-76T44:16:91s233777\"\n },\n \"type\": \"aws_cur_config\",\n \"id\": 47060420\n },\n {\n \"attributes\": {\n \"account_id\": \"123456789123\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"bucket_region\": \"us-east-1\",\n \"report_name\": \"dd-report-name\",\n \"report_prefix\": \"dd-report-prefix\",\n \"status\": \"active\",\n \"account_filters\": {\n \"excluded_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ],\n \"include_new_accounts\": true,\n \"included_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ]\n },\n \"created_at\": \"0337-10-80T94:88:89J718985\",\n \"error_messages\": [\n \"cillum labore aute et\",\n \"in aliquip qui est\"\n ],\n \"status_updated_at\": \"5468-35-20T51:62:68.018511\",\n \"updated_at\": \"5179-83-70T07:74:17/218238\"\n },\n \"type\": \"aws_cur_config\",\n \"id\": -42009360\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_filters\": {\n \"excluded_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ],\n \"include_new_accounts\": true,\n \"included_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ]\n },\n \"is_enabled\": true\n },\n \"type\": \"aws_cur_config_patch_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_filters\": {\n \"excluded_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ],\n \"include_new_accounts\": true,\n \"included_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ]\n },\n \"is_enabled\": true\n },\n \"type\": \"aws_cur_config_patch_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update Cloud Cost Management GCP Usage Cost config",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"is_enabled\": true\n },\n \"type\": \"gcp_uc_config_patch_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id",
"value": "proident amet voluptate"
}
]
},
"description": "Update the status of an GCP Usage Cost config (active/archived)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"is_enabled\": true\n },\n \"type\": \"gcp_uc_config_patch_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"account_id\": \"123456_A123BC_12AB34\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"dataset\": \"billing\",\n \"export_prefix\": \"datadog_cloud_cost_usage_export\",\n \"export_project_name\": \"dd-cloud-cost-report\",\n \"service_account\": \"dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com\",\n \"status\": \"active\",\n \"created_at\": \"1390-71-51T06:45:71H300541\",\n \"error_messages\": [\n \"dolor\",\n \"incididunt qui cillum\"\n ],\n \"project_id\": \"my-project-123\",\n \"status_updated_at\": \"5351-58-13T52:64:07#351076\",\n \"updated_at\": \"2175-00-78T90:79:33N553446\"\n },\n \"type\": \"gcp_uc_config\",\n \"id\": \"ad\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"is_enabled\": true\n },\n \"type\": \"gcp_uc_config_patch_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"is_enabled\": true\n },\n \"type\": \"gcp_uc_config_patch_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"is_enabled\": true\n },\n \"type\": \"gcp_uc_config_patch_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"is_enabled\": true\n },\n \"type\": \"gcp_uc_config_patch_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create Cloud Cost Management AWS CUR config",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_id\": \"123456789123\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"report_name\": \"dd-report-name\",\n \"report_prefix\": \"dd-report-prefix\",\n \"account_filters\": {\n \"excluded_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ],\n \"include_new_accounts\": true,\n \"included_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ]\n },\n \"bucket_region\": \"us-east-1\",\n \"is_enabled\": false,\n \"months\": -92296445\n },\n \"type\": \"aws_cur_config_post_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config"
]
},
"description": "Create a Cloud Cost Management account for an AWS CUR config."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_id\": \"123456789123\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"report_name\": \"dd-report-name\",\n \"report_prefix\": \"dd-report-prefix\",\n \"account_filters\": {\n \"excluded_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ],\n \"include_new_accounts\": true,\n \"included_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ]\n },\n \"bucket_region\": \"us-east-1\",\n \"is_enabled\": false,\n \"months\": -92296445\n },\n \"type\": \"aws_cur_config_post_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"account_id\": \"123456789123\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"bucket_region\": \"us-east-1\",\n \"report_name\": \"dd-report-name\",\n \"report_prefix\": \"dd-report-prefix\",\n \"status\": \"active\",\n \"account_filters\": {\n \"excluded_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ],\n \"include_new_accounts\": true,\n \"included_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ]\n },\n \"created_at\": \"6408-71-43T25:50:83k055506\",\n \"error_messages\": [\n \"magna velit mi\",\n \"est do\"\n ],\n \"status_updated_at\": \"3016-33-46T49:99:78i276943\",\n \"updated_at\": \"8913-22-85T20:47:64w073700\"\n },\n \"type\": \"aws_cur_config\",\n \"id\": 70615956\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_id\": \"123456789123\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"report_name\": \"dd-report-name\",\n \"report_prefix\": \"dd-report-prefix\",\n \"account_filters\": {\n \"excluded_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ],\n \"include_new_accounts\": true,\n \"included_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ]\n },\n \"bucket_region\": \"us-east-1\",\n \"is_enabled\": false,\n \"months\": -92296445\n },\n \"type\": \"aws_cur_config_post_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_id\": \"123456789123\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"report_name\": \"dd-report-name\",\n \"report_prefix\": \"dd-report-prefix\",\n \"account_filters\": {\n \"excluded_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ],\n \"include_new_accounts\": true,\n \"included_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ]\n },\n \"bucket_region\": \"us-east-1\",\n \"is_enabled\": false,\n \"months\": -92296445\n },\n \"type\": \"aws_cur_config_post_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_id\": \"123456789123\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"report_name\": \"dd-report-name\",\n \"report_prefix\": \"dd-report-prefix\",\n \"account_filters\": {\n \"excluded_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ],\n \"include_new_accounts\": true,\n \"included_accounts\": [\n \"123456789123\",\n \"123456789143\"\n ]\n },\n \"bucket_region\": \"us-east-1\",\n \"is_enabled\": false,\n \"months\": -92296445\n },\n \"type\": \"aws_cur_config_post_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create Cloud Cost Management GCP Usage Cost config",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"billing_account_id\": \"123456_A123BC_12AB34\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"export_project_name\": \"dd-cloud-cost-report\",\n \"export_dataset_name\": \"billing\",\n \"service_account\": \"dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com\",\n \"export_prefix\": \"datadog_cloud_cost_usage_export\"\n },\n \"type\": \"gcp_uc_config_post_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config"
]
},
"description": "Create a Cloud Cost Management account for an GCP Usage Cost config."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"billing_account_id\": \"123456_A123BC_12AB34\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"export_project_name\": \"dd-cloud-cost-report\",\n \"export_dataset_name\": \"billing\",\n \"service_account\": \"dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com\",\n \"export_prefix\": \"datadog_cloud_cost_usage_export\"\n },\n \"type\": \"gcp_uc_config_post_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"account_id\": \"123456_A123BC_12AB34\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"dataset\": \"billing\",\n \"export_prefix\": \"datadog_cloud_cost_usage_export\",\n \"export_project_name\": \"dd-cloud-cost-report\",\n \"service_account\": \"dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com\",\n \"status\": \"active\",\n \"created_at\": \"1390-71-51T06:45:71H300541\",\n \"error_messages\": [\n \"dolor\",\n \"incididunt qui cillum\"\n ],\n \"project_id\": \"my-project-123\",\n \"status_updated_at\": \"5351-58-13T52:64:07#351076\",\n \"updated_at\": \"2175-00-78T90:79:33N553446\"\n },\n \"type\": \"gcp_uc_config\",\n \"id\": \"ad\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"billing_account_id\": \"123456_A123BC_12AB34\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"export_project_name\": \"dd-cloud-cost-report\",\n \"export_dataset_name\": \"billing\",\n \"service_account\": \"dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com\",\n \"export_prefix\": \"datadog_cloud_cost_usage_export\"\n },\n \"type\": \"gcp_uc_config_post_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"billing_account_id\": \"123456_A123BC_12AB34\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"export_project_name\": \"dd-cloud-cost-report\",\n \"export_dataset_name\": \"billing\",\n \"service_account\": \"dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com\",\n \"export_prefix\": \"datadog_cloud_cost_usage_export\"\n },\n \"type\": \"gcp_uc_config_post_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"billing_account_id\": \"123456_A123BC_12AB34\",\n \"bucket_name\": \"dd-cost-bucket\",\n \"export_project_name\": \"dd-cloud-cost-report\",\n \"export_dataset_name\": \"billing\",\n \"service_account\": \"dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com\",\n \"export_prefix\": \"datadog_cloud_cost_usage_export\"\n },\n \"type\": \"gcp_uc_config_post_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete Cloud Cost Management AWS CUR config",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id",
"value": "proident amet voluptate"
}
]
},
"description": "Archive a Cloud Cost Management Account."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/aws_cur_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"aws_cur_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete Cloud Cost Management GCP Usage Cost config",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id",
"value": "proident amet voluptate"
}
]
},
"description": "Archive a Cloud Cost Management account."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/gcp_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"gcp_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List Cloud Cost Management Azure configs",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config"
]
},
"description": "List the Azure configs."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"configs\": [\n {\n \"account_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"client_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"dataset_type\": \"actual\",\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"scope\": \"/subscriptions/1234abcd-1234-abcd-1234-1234abcd1234\",\n \"status\": \"active\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\",\n \"created_at\": \"0050-73-62T44:60:72:125431\",\n \"error_messages\": [\n \"ullamco aliqua\",\n \"deserunt sed aliqua\"\n ],\n \"id\": 5410341,\n \"status_updated_at\": \"0301-23-65T92:90:43?180170\",\n \"updated_at\": \"3270-51-67T01:32:59#799999\"\n },\n {\n \"account_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"client_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"dataset_type\": \"actual\",\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"scope\": \"/subscriptions/1234abcd-1234-abcd-1234-1234abcd1234\",\n \"status\": \"active\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\",\n \"created_at\": \"0701-60-54T07:25:50j120316\",\n \"error_messages\": [\n \"consectetur nisi\",\n \"exercitation qui in est\"\n ],\n \"id\": -77354964,\n \"status_updated_at\": \"0467-16-55T25:75:812243108\",\n \"updated_at\": \"3866-57-89T23:46:58(124164\"\n }\n ],\n \"id\": 42272481\n },\n \"type\": \"azure_uc_configs\",\n \"id\": -55979909\n },\n {\n \"attributes\": {\n \"configs\": [\n {\n \"account_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"client_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"dataset_type\": \"actual\",\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"scope\": \"/subscriptions/1234abcd-1234-abcd-1234-1234abcd1234\",\n \"status\": \"active\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\",\n \"created_at\": \"3095-55-05T78:42:02-587619\",\n \"error_messages\": [\n \"culpa \",\n \"Excepteur aliqua deserunt ad ullamco\"\n ],\n \"id\": 34848547,\n \"status_updated_at\": \"4334-34-93T83:17:62:962670\",\n \"updated_at\": \"7104-02-76T86:54:87F992483\"\n },\n {\n \"account_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"client_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"dataset_type\": \"actual\",\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"scope\": \"/subscriptions/1234abcd-1234-abcd-1234-1234abcd1234\",\n \"status\": \"active\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\",\n \"created_at\": \"8426-97-60T31:41:14a134328\",\n \"error_messages\": [\n \"ipsum ut sed laboris\",\n \"labore occae\"\n ],\n \"id\": 62474963,\n \"status_updated_at\": \"7174-83-55T46:88:94L566119\",\n \"updated_at\": \"1308-12-20T04:67:24n432395\"\n }\n ],\n \"id\": -47418091\n },\n \"type\": \"azure_uc_configs\",\n \"id\": -86930339\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update Cloud Cost Management Azure config",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"is_enabled\": true\n },\n \"type\": \"azure_uc_config_patch_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id",
"value": "proident amet voluptate"
}
]
},
"description": "Update the status of an Azure config (active/archived)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"is_enabled\": true\n },\n \"type\": \"azure_uc_config_patch_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"configs\": [\n {\n \"account_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"client_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"dataset_type\": \"actual\",\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"scope\": \"/subscriptions/1234abcd-1234-abcd-1234-1234abcd1234\",\n \"status\": \"active\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\",\n \"created_at\": \"4861-90-48T34:32:26}825050\",\n \"error_messages\": [\n \"velit cupidatat\",\n \"magna \"\n ],\n \"id\": -15382763,\n \"status_updated_at\": \"4040-01-66T10:46:32=049341\",\n \"updated_at\": \"1515-36-13T93:07:52u160281\"\n },\n {\n \"account_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"client_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"dataset_type\": \"actual\",\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"scope\": \"/subscriptions/1234abcd-1234-abcd-1234-1234abcd1234\",\n \"status\": \"active\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\",\n \"created_at\": \"7584-61-16T04:49:084924154\",\n \"error_messages\": [\n \"ad cillum ea reprehenderit ex\",\n \"dolore dolor nostrud Ut\"\n ],\n \"id\": -98432097,\n \"status_updated_at\": \"9206-29-05T32:45:12x306723\",\n \"updated_at\": \"6832-27-79T45:47:28~592932\"\n }\n ],\n \"id\": -97011218\n },\n \"type\": \"azure_uc_configs\",\n \"id\": -49238413\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"is_enabled\": true\n },\n \"type\": \"azure_uc_config_patch_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"is_enabled\": true\n },\n \"type\": \"azure_uc_config_patch_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"is_enabled\": true\n },\n \"type\": \"azure_uc_config_patch_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create Cloud Cost Management Azure configs",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"actual_bill_config\": {\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\"\n },\n \"amortized_bill_config\": {\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\"\n },\n \"client_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"scope\": \"/subscriptions/1234abcd-1234-abcd-1234-1234abcd1234\",\n \"is_enabled\": false\n },\n \"type\": \"azure_uc_config_post_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config"
]
},
"description": "Create a Cloud Cost Management account for an Azure config."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"actual_bill_config\": {\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\"\n },\n \"amortized_bill_config\": {\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\"\n },\n \"client_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"scope\": \"/subscriptions/1234abcd-1234-abcd-1234-1234abcd1234\",\n \"is_enabled\": false\n },\n \"type\": \"azure_uc_config_post_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"configs\": [\n {\n \"account_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"client_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"dataset_type\": \"actual\",\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"scope\": \"/subscriptions/1234abcd-1234-abcd-1234-1234abcd1234\",\n \"status\": \"active\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\",\n \"created_at\": \"4861-90-48T34:32:26}825050\",\n \"error_messages\": [\n \"velit cupidatat\",\n \"magna \"\n ],\n \"id\": -15382763,\n \"status_updated_at\": \"4040-01-66T10:46:32=049341\",\n \"updated_at\": \"1515-36-13T93:07:52u160281\"\n },\n {\n \"account_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"client_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"dataset_type\": \"actual\",\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"scope\": \"/subscriptions/1234abcd-1234-abcd-1234-1234abcd1234\",\n \"status\": \"active\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\",\n \"created_at\": \"7584-61-16T04:49:084924154\",\n \"error_messages\": [\n \"ad cillum ea reprehenderit ex\",\n \"dolore dolor nostrud Ut\"\n ],\n \"id\": -98432097,\n \"status_updated_at\": \"9206-29-05T32:45:12x306723\",\n \"updated_at\": \"6832-27-79T45:47:28~592932\"\n }\n ],\n \"id\": -97011218\n },\n \"type\": \"azure_uc_configs\",\n \"id\": -49238413\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"actual_bill_config\": {\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\"\n },\n \"amortized_bill_config\": {\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\"\n },\n \"client_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"scope\": \"/subscriptions/1234abcd-1234-abcd-1234-1234abcd1234\",\n \"is_enabled\": false\n },\n \"type\": \"azure_uc_config_post_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"actual_bill_config\": {\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\"\n },\n \"amortized_bill_config\": {\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\"\n },\n \"client_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"scope\": \"/subscriptions/1234abcd-1234-abcd-1234-1234abcd1234\",\n \"is_enabled\": false\n },\n \"type\": \"azure_uc_config_post_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"actual_bill_config\": {\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\"\n },\n \"amortized_bill_config\": {\n \"export_name\": \"dd-actual-export\",\n \"export_path\": \"dd-export-path\",\n \"storage_account\": \"dd-storage-account\",\n \"storage_container\": \"dd-storage-container\"\n },\n \"client_id\": \"1234abcd-1234-abcd-1234-1234abcd1234\",\n \"scope\": \"/subscriptions/1234abcd-1234-abcd-1234-1234abcd1234\",\n \"is_enabled\": false\n },\n \"type\": \"azure_uc_config_post_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete Cloud Cost Management Azure config",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id",
"value": "proident amet voluptate"
}
]
},
"description": "Archive a Cloud Cost Management Account."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/azure_uc_config/:cloud_account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"azure_uc_config",
":cloud_account_id"
],
"variable": [
{
"key": "cloud_account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List Custom Costs files",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs"
]
},
"description": "List the Custom Costs files."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"billed_cost\": 100.5,\n \"billing_currency\": \"USD\",\n \"charge_period\": {\n \"end\": 1706745600000,\n \"start\": 1704067200000\n },\n \"name\": \"my_file.json\",\n \"provider_names\": [\n \"my_provider\",\n \"my_provider\"\n ],\n \"status\": \"active\",\n \"uploaded_at\": 1704067200000,\n \"uploaded_by\": {\n \"email\": \"email.test@datadohq.com\",\n \"icon\": \"icon.png\",\n \"name\": \"Test User\"\n }\n },\n \"id\": \"ut anim\",\n \"type\": \"occaecat\"\n },\n {\n \"attributes\": {\n \"billed_cost\": 100.5,\n \"billing_currency\": \"USD\",\n \"charge_period\": {\n \"end\": 1706745600000,\n \"start\": 1704067200000\n },\n \"name\": \"my_file.json\",\n \"provider_names\": [\n \"my_provider\",\n \"my_provider\"\n ],\n \"status\": \"active\",\n \"uploaded_at\": 1704067200000,\n \"uploaded_by\": {\n \"email\": \"email.test@datadohq.com\",\n \"icon\": \"icon.png\",\n \"name\": \"Test User\"\n }\n },\n \"id\": \"reprehenderit ex sint commodo\",\n \"type\": \"ea nostrud nulla sint\"\n }\n ],\n \"meta\": {\n \"total_filtered_count\": 92213288,\n \"version\": \"au\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Upload Custom Costs file",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"BilledCost\": 100.5,\n \"BillingCurrency\": \"USD\",\n \"ChargeDescription\": \"Monthly usage charge for my service\",\n \"ChargePeriodEnd\": \"2023-02-28\",\n \"ChargePeriodStart\": \"2023-02-01\",\n \"ProviderName\": \"commodo Lorem\",\n \"Tags\": {\n \"in_1\": \"eu ut\",\n \"esse1\": \"Duis cillum qui nulla dolore\"\n }\n },\n {\n \"BilledCost\": 100.5,\n \"BillingCurrency\": \"USD\",\n \"ChargeDescription\": \"Monthly usage charge for my service\",\n \"ChargePeriodEnd\": \"2023-02-28\",\n \"ChargePeriodStart\": \"2023-02-01\",\n \"ProviderName\": \"cillum anim Lorem velit\",\n \"Tags\": {\n \"fugiat937\": \"ut ea Ut consectetur dolore\",\n \"aute_1\": \"Excepteur ut\"\n }\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs"
]
},
"description": "Upload a Custom Costs file."
},
"response": [
{
"name": "Accepted",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"BilledCost\": 100.5,\n \"BillingCurrency\": \"USD\",\n \"ChargeDescription\": \"Monthly usage charge for my service\",\n \"ChargePeriodEnd\": \"2023-02-28\",\n \"ChargePeriodStart\": \"2023-02-01\",\n \"ProviderName\": \"commodo Lorem\",\n \"Tags\": {\n \"in_1\": \"eu ut\",\n \"esse1\": \"Duis cillum qui nulla dolore\"\n }\n },\n {\n \"BilledCost\": 100.5,\n \"BillingCurrency\": \"USD\",\n \"ChargeDescription\": \"Monthly usage charge for my service\",\n \"ChargePeriodEnd\": \"2023-02-28\",\n \"ChargePeriodStart\": \"2023-02-01\",\n \"ProviderName\": \"cillum anim Lorem velit\",\n \"Tags\": {\n \"fugiat937\": \"ut ea Ut consectetur dolore\",\n \"aute_1\": \"Excepteur ut\"\n }\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"billed_cost\": 100.5,\n \"billing_currency\": \"USD\",\n \"charge_period\": {\n \"end\": 1706745600000,\n \"start\": 1704067200000\n },\n \"name\": \"my_file.json\",\n \"provider_names\": [\n \"my_provider\",\n \"my_provider\"\n ],\n \"status\": \"active\",\n \"uploaded_at\": 1704067200000,\n \"uploaded_by\": {\n \"email\": \"email.test@datadohq.com\",\n \"icon\": \"icon.png\",\n \"name\": \"Test User\"\n }\n },\n \"id\": \"mollit\",\n \"type\": \"nostrud eu\"\n },\n \"meta\": {\n \"version\": \"occaecat dolor aliqua\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"BilledCost\": 100.5,\n \"BillingCurrency\": \"USD\",\n \"ChargeDescription\": \"Monthly usage charge for my service\",\n \"ChargePeriodEnd\": \"2023-02-28\",\n \"ChargePeriodStart\": \"2023-02-01\",\n \"ProviderName\": \"commodo Lorem\",\n \"Tags\": {\n \"in_1\": \"eu ut\",\n \"esse1\": \"Duis cillum qui nulla dolore\"\n }\n },\n {\n \"BilledCost\": 100.5,\n \"BillingCurrency\": \"USD\",\n \"ChargeDescription\": \"Monthly usage charge for my service\",\n \"ChargePeriodEnd\": \"2023-02-28\",\n \"ChargePeriodStart\": \"2023-02-01\",\n \"ProviderName\": \"cillum anim Lorem velit\",\n \"Tags\": {\n \"fugiat937\": \"ut ea Ut consectetur dolore\",\n \"aute_1\": \"Excepteur ut\"\n }\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"BilledCost\": 100.5,\n \"BillingCurrency\": \"USD\",\n \"ChargeDescription\": \"Monthly usage charge for my service\",\n \"ChargePeriodEnd\": \"2023-02-28\",\n \"ChargePeriodStart\": \"2023-02-01\",\n \"ProviderName\": \"commodo Lorem\",\n \"Tags\": {\n \"in_1\": \"eu ut\",\n \"esse1\": \"Duis cillum qui nulla dolore\"\n }\n },\n {\n \"BilledCost\": 100.5,\n \"BillingCurrency\": \"USD\",\n \"ChargeDescription\": \"Monthly usage charge for my service\",\n \"ChargePeriodEnd\": \"2023-02-28\",\n \"ChargePeriodStart\": \"2023-02-01\",\n \"ProviderName\": \"cillum anim Lorem velit\",\n \"Tags\": {\n \"fugiat937\": \"ut ea Ut consectetur dolore\",\n \"aute_1\": \"Excepteur ut\"\n }\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get Custom Costs file",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs/:file_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs",
":file_id"
],
"variable": [
{
"key": "file_id",
"value": "proident amet voluptate"
}
]
},
"description": "Fetch the specified Custom Costs file."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs/:file_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs",
":file_id"
],
"variable": [
{
"key": "file_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"billed_cost\": 100.5,\n \"billing_currency\": \"USD\",\n \"charge_period\": {\n \"end\": 1706745600000,\n \"start\": 1704067200000\n },\n \"content\": [\n {\n \"BilledCost\": 100.5,\n \"BillingCurrency\": \"USD\",\n \"ChargeDescription\": \"Monthly usage charge for my service\",\n \"ChargePeriodEnd\": \"2023-02-28\",\n \"ChargePeriodStart\": \"2023-02-01\",\n \"ProviderName\": \"veniam exercitation et\",\n \"Tags\": {\n \"temporc_0\": \"esse et dolor\"\n }\n },\n {\n \"BilledCost\": 100.5,\n \"BillingCurrency\": \"USD\",\n \"ChargeDescription\": \"Monthly usage charge for my service\",\n \"ChargePeriodEnd\": \"2023-02-28\",\n \"ChargePeriodStart\": \"2023-02-01\",\n \"ProviderName\": \"laborum\",\n \"Tags\": {\n \"id3f9\": \"nulla tempor reprehenderit\",\n \"occaecat_4\": \"Excepteur qui commodo non\"\n }\n }\n ],\n \"name\": \"my_file.json\",\n \"provider_names\": [\n \"my_provider\",\n \"my_provider\"\n ],\n \"status\": \"active\",\n \"uploaded_at\": 1704067200000,\n \"uploaded_by\": {\n \"email\": \"email.test@datadohq.com\",\n \"icon\": \"icon.png\",\n \"name\": \"Test User\"\n }\n },\n \"id\": \"cupidatat Ut mollit\",\n \"type\": \"eu \"\n },\n \"meta\": {\n \"version\": \"co\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs/:file_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs",
":file_id"
],
"variable": [
{
"key": "file_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs/:file_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs",
":file_id"
],
"variable": [
{
"key": "file_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete Custom Costs file",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs/:file_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs",
":file_id"
],
"variable": [
{
"key": "file_id",
"value": "proident amet voluptate"
}
]
},
"description": "Delete the specified Custom Costs file."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs/:file_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs",
":file_id"
],
"variable": [
{
"key": "file_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs/:file_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs",
":file_id"
],
"variable": [
{
"key": "file_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/custom_costs/:file_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"custom_costs",
":file_id"
],
"variable": [
{
"key": "file_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create or update a budget",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": 1738258683590,\n \"created_by\": \"00000000-0a0a-0a0a-aaa0-00000000000a\",\n \"end_month\": 202502,\n \"entries\": [\n {\n \"amount\": 500,\n \"month\": 202501,\n \"tag_filters\": [\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n },\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n }\n ]\n },\n {\n \"amount\": 500,\n \"month\": 202501,\n \"tag_filters\": [\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n },\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n }\n ]\n }\n ],\n \"metrics_query\": \"aws.cost.amortized{service:ec2} by {service}\",\n \"name\": \"my budget\",\n \"org_id\": 123,\n \"start_month\": 202501,\n \"total_amount\": 1000,\n \"updated_at\": 1738258683590,\n \"updated_by\": \"00000000-0a0a-0a0a-aaa0-00000000000a\"\n },\n \"id\": \"00000000-0a0a-0a0a-aaa0-00000000000a\",\n \"type\": \"dolore c\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budget",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budget"
]
},
"description": "Create a new budget or update an existing one."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": 1738258683590,\n \"created_by\": \"00000000-0a0a-0a0a-aaa0-00000000000a\",\n \"end_month\": 202502,\n \"entries\": [\n {\n \"amount\": 500,\n \"month\": 202501,\n \"tag_filters\": [\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n },\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n }\n ]\n },\n {\n \"amount\": 500,\n \"month\": 202501,\n \"tag_filters\": [\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n },\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n }\n ]\n }\n ],\n \"metrics_query\": \"aws.cost.amortized{service:ec2} by {service}\",\n \"name\": \"my budget\",\n \"org_id\": 123,\n \"start_month\": 202501,\n \"total_amount\": 1000,\n \"updated_at\": 1738258683590,\n \"updated_by\": \"00000000-0a0a-0a0a-aaa0-00000000000a\"\n },\n \"id\": \"00000000-0a0a-0a0a-aaa0-00000000000a\",\n \"type\": \"dolore c\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budget",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budget"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": 1738258683590,\n \"created_by\": \"00000000-0a0a-0a0a-aaa0-00000000000a\",\n \"end_month\": 202502,\n \"entries\": [\n {\n \"amount\": 500,\n \"month\": 202501,\n \"tag_filters\": [\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n },\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n }\n ]\n },\n {\n \"amount\": 500,\n \"month\": 202501,\n \"tag_filters\": [\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n },\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n }\n ]\n }\n ],\n \"metrics_query\": \"aws.cost.amortized{service:ec2} by {service}\",\n \"name\": \"my budget\",\n \"org_id\": 123,\n \"start_month\": 202501,\n \"total_amount\": 1000,\n \"updated_at\": 1738258683590,\n \"updated_by\": \"00000000-0a0a-0a0a-aaa0-00000000000a\"\n },\n \"id\": \"00000000-0a0a-0a0a-aaa0-00000000000a\",\n \"type\": \"dolore c\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": 1738258683590,\n \"created_by\": \"00000000-0a0a-0a0a-aaa0-00000000000a\",\n \"end_month\": 202502,\n \"entries\": [\n {\n \"amount\": 500,\n \"month\": 202501,\n \"tag_filters\": [\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n },\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n }\n ]\n },\n {\n \"amount\": 500,\n \"month\": 202501,\n \"tag_filters\": [\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n },\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n }\n ]\n }\n ],\n \"metrics_query\": \"aws.cost.amortized{service:ec2} by {service}\",\n \"name\": \"my budget\",\n \"org_id\": 123,\n \"start_month\": 202501,\n \"total_amount\": 1000,\n \"updated_at\": 1738258683590,\n \"updated_by\": \"00000000-0a0a-0a0a-aaa0-00000000000a\"\n },\n \"id\": \"00000000-0a0a-0a0a-aaa0-00000000000a\",\n \"type\": \"dolore c\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budget",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budget"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": 1738258683590,\n \"created_by\": \"00000000-0a0a-0a0a-aaa0-00000000000a\",\n \"end_month\": 202502,\n \"entries\": [\n {\n \"amount\": 500,\n \"month\": 202501,\n \"tag_filters\": [\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n },\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n }\n ]\n },\n {\n \"amount\": 500,\n \"month\": 202501,\n \"tag_filters\": [\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n },\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n }\n ]\n }\n ],\n \"metrics_query\": \"aws.cost.amortized{service:ec2} by {service}\",\n \"name\": \"my budget\",\n \"org_id\": 123,\n \"start_month\": 202501,\n \"total_amount\": 1000,\n \"updated_at\": 1738258683590,\n \"updated_by\": \"00000000-0a0a-0a0a-aaa0-00000000000a\"\n },\n \"id\": \"00000000-0a0a-0a0a-aaa0-00000000000a\",\n \"type\": \"dolore c\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budget",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budget"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": 1738258683590,\n \"created_by\": \"00000000-0a0a-0a0a-aaa0-00000000000a\",\n \"end_month\": 202502,\n \"entries\": [\n {\n \"amount\": 500,\n \"month\": 202501,\n \"tag_filters\": [\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n },\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n }\n ]\n },\n {\n \"amount\": 500,\n \"month\": 202501,\n \"tag_filters\": [\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n },\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n }\n ]\n }\n ],\n \"metrics_query\": \"aws.cost.amortized{service:ec2} by {service}\",\n \"name\": \"my budget\",\n \"org_id\": 123,\n \"start_month\": 202501,\n \"total_amount\": 1000,\n \"updated_at\": 1738258683590,\n \"updated_by\": \"00000000-0a0a-0a0a-aaa0-00000000000a\"\n },\n \"id\": \"00000000-0a0a-0a0a-aaa0-00000000000a\",\n \"type\": \"dolore c\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budget",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budget"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a budget",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budget/:budget_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budget",
":budget_id"
],
"variable": [
{
"key": "budget_id",
"value": "proident amet voluptate"
}
]
},
"description": "Delete a budget."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budget/:budget_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budget",
":budget_id"
],
"variable": [
{
"key": "budget_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budget/:budget_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budget",
":budget_id"
],
"variable": [
{
"key": "budget_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budget/:budget_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budget",
":budget_id"
],
"variable": [
{
"key": "budget_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a budget",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budget/:budget_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budget",
":budget_id"
],
"variable": [
{
"key": "budget_id",
"value": "proident amet voluptate"
}
]
},
"description": "Get a budget."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budget/:budget_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budget",
":budget_id"
],
"variable": [
{
"key": "budget_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": 1738258683590,\n \"created_by\": \"00000000-0a0a-0a0a-aaa0-00000000000a\",\n \"end_month\": 202502,\n \"entries\": [\n {\n \"amount\": 500,\n \"month\": 202501,\n \"tag_filters\": [\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n },\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n }\n ]\n },\n {\n \"amount\": 500,\n \"month\": 202501,\n \"tag_filters\": [\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n },\n {\n \"tag_key\": \"service\",\n \"tag_value\": \"ec2\"\n }\n ]\n }\n ],\n \"metrics_query\": \"aws.cost.amortized{service:ec2} by {service}\",\n \"name\": \"my budget\",\n \"org_id\": 123,\n \"start_month\": 202501,\n \"total_amount\": 1000,\n \"updated_at\": 1738258683590,\n \"updated_by\": \"00000000-0a0a-0a0a-aaa0-00000000000a\"\n },\n \"id\": \"00000000-0a0a-0a0a-aaa0-00000000000a\",\n \"type\": \"dolore c\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budget/:budget_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budget",
":budget_id"
],
"variable": [
{
"key": "budget_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budget/:budget_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budget",
":budget_id"
],
"variable": [
{
"key": "budget_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budget/:budget_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budget",
":budget_id"
],
"variable": [
{
"key": "budget_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List budgets",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budgets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budgets"
]
},
"description": "List budgets."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budgets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budgets"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": 1741011342772,\n \"created_by\": \"user1\",\n \"end_month\": 202502,\n \"metrics_query\": \"aws.cost.amortized{service:ec2} by {service}\",\n \"name\": \"my budget\",\n \"org_id\": 123,\n \"start_month\": 202501,\n \"total_amount\": 1000,\n \"updated_at\": 1741011342772,\n \"updated_by\": \"user2\"\n },\n \"id\": \"00000000-0a0a-0a0a-aaa0-00000000000a\",\n \"type\": \"budget\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost/budgets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost",
"budgets"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "The Cloud Cost Management API allows you to set up, edit, and delete Cloud Cost Management accounts for AWS, Azure, and GCP. You can query your cost data by using the [Metrics endpoint](https://docs.datadoghq.com/api/latest/metrics/#query-timeseries-data-across-multiple-products) and the `cloud_cost` data source. For more information, see the [Cloud Cost Management documentation](https://docs.datadoghq.com/cloud_cost_management/).",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Cloud Network Monitoring",
"item": [
{
"name": "Get all aggregated connections",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/network/connections/aggregate?from=36993837&to=36993837&group_by=consectetur consequat dolor&tags=consectetur consequat dolor&limit=100",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"network",
"connections",
"aggregate"
],
"query": [
{
"key": "from",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "to",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "group_by",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of fields to group connections by. The maximum number of group_by(s) is 10."
},
{
"key": "tags",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of tags to filter connections by."
},
{
"key": "limit",
"value": "100",
"description": "The number of connections to be returned. The maximum value is 7500. The default is 100."
}
]
},
"description": "Get all aggregated connections."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/network/connections/aggregate?from=36993837&to=36993837&group_by=consectetur consequat dolor&tags=consectetur consequat dolor&limit=100",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"network",
"connections",
"aggregate"
],
"query": [
{
"key": "from",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "to",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "group_by",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of fields to group connections by. The maximum number of group_by(s) is 10."
},
{
"key": "tags",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of tags to filter connections by."
},
{
"key": "limit",
"value": "100",
"description": "The number of connections to be returned. The maximum value is 7500. The default is 100."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"bytes_sent_by_client\": 100,\n \"bytes_sent_by_server\": 200,\n \"group_bys\": {\n \"client_team\": [\n \"networks\"\n ],\n \"server_service\": [\n \"hucklebuck\"\n ]\n },\n \"packets_sent_by_client\": 10,\n \"packets_sent_by_server\": 20,\n \"rtt_micro_seconds\": 800,\n \"tcp_closed_connections\": 30,\n \"tcp_established_connections\": 40,\n \"tcp_refusals\": 7,\n \"tcp_resets\": 5,\n \"tcp_retransmits\": 30,\n \"tcp_timeouts\": 6\n },\n \"id\": \"client_team:networks, server_service:hucklebuck\",\n \"type\": \"aggregated_connection\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/network/connections/aggregate?from=36993837&to=36993837&group_by=consectetur consequat dolor&tags=consectetur consequat dolor&limit=100",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"network",
"connections",
"aggregate"
],
"query": [
{
"key": "from",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "to",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "group_by",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of fields to group connections by. The maximum number of group_by(s) is 10."
},
{
"key": "tags",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of tags to filter connections by."
},
{
"key": "limit",
"value": "100",
"description": "The number of connections to be returned. The maximum value is 7500. The default is 100."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/network/connections/aggregate?from=36993837&to=36993837&group_by=consectetur consequat dolor&tags=consectetur consequat dolor&limit=100",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"network",
"connections",
"aggregate"
],
"query": [
{
"key": "from",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "to",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "group_by",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of fields to group connections by. The maximum number of group_by(s) is 10."
},
{
"key": "tags",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of tags to filter connections by."
},
{
"key": "limit",
"value": "100",
"description": "The number of connections to be returned. The maximum value is 7500. The default is 100."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all aggregated DNS traffic",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/network/dns/aggregate?from=36993837&to=36993837&group_by=consectetur consequat dolor&tags=consectetur consequat dolor&limit=100",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"network",
"dns",
"aggregate"
],
"query": [
{
"key": "from",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "to",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "group_by",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of fields to group DNS traffic by. The server side defaults to `network.dns_query` if unspecified. `server_ungrouped` may be used if groups are not desired. The maximum number of group_by(s) is 10."
},
{
"key": "tags",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of tags to filter DNS traffic by."
},
{
"key": "limit",
"value": "100",
"description": "The number of aggregated DNS entries to be returned. The maximum value is 7500. The default is 100."
}
]
},
"description": "Get all aggregated DNS traffic."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/network/dns/aggregate?from=36993837&to=36993837&group_by=consectetur consequat dolor&tags=consectetur consequat dolor&limit=100",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"network",
"dns",
"aggregate"
],
"query": [
{
"key": "from",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "to",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "group_by",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of fields to group DNS traffic by. The server side defaults to `network.dns_query` if unspecified. `server_ungrouped` may be used if groups are not desired. The maximum number of group_by(s) is 10."
},
{
"key": "tags",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of tags to filter DNS traffic by."
},
{
"key": "limit",
"value": "100",
"description": "The number of aggregated DNS entries to be returned. The maximum value is 7500. The default is 100."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"group_bys\": [\n {\n \"key\": \"client_service\",\n \"value\": \"example-service\"\n },\n {\n \"key\": \"network.dns_query\",\n \"value\": \"example.com\"\n }\n ],\n \"metrics\": [\n {\n \"key\": \"dns_total_requests\",\n \"value\": 100\n },\n {\n \"key\": \"dns_failures\",\n \"value\": 7\n },\n {\n \"key\": \"dns_successful_responses\",\n \"value\": 93\n },\n {\n \"key\": \"dns_failed_responses\",\n \"value\": 5\n },\n {\n \"key\": \"dns_timeouts\",\n \"value\": 2\n },\n {\n \"key\": \"dns_responses.nxdomain\",\n \"value\": 1\n },\n {\n \"key\": \"dns_responses.servfail\",\n \"value\": 1\n },\n {\n \"key\": \"dns_responses.other\",\n \"value\": 3\n },\n {\n \"key\": \"dns_success_latency_percentile\",\n \"value\": 50\n },\n {\n \"key\": \"dns_failure_latency_percentile\",\n \"value\": 75\n }\n ]\n },\n \"id\": \"client_service:example-service,network.dns_query:example.com\",\n \"type\": \"aggregated_dns\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/network/dns/aggregate?from=36993837&to=36993837&group_by=consectetur consequat dolor&tags=consectetur consequat dolor&limit=100",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"network",
"dns",
"aggregate"
],
"query": [
{
"key": "from",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "to",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "group_by",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of fields to group DNS traffic by. The server side defaults to `network.dns_query` if unspecified. `server_ungrouped` may be used if groups are not desired. The maximum number of group_by(s) is 10."
},
{
"key": "tags",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of tags to filter DNS traffic by."
},
{
"key": "limit",
"value": "100",
"description": "The number of aggregated DNS entries to be returned. The maximum value is 7500. The default is 100."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/network/dns/aggregate?from=36993837&to=36993837&group_by=consectetur consequat dolor&tags=consectetur consequat dolor&limit=100",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"network",
"dns",
"aggregate"
],
"query": [
{
"key": "from",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "to",
"value": "36993837",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`."
},
{
"key": "group_by",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of fields to group DNS traffic by. The server side defaults to `network.dns_query` if unspecified. `server_ungrouped` may be used if groups are not desired. The maximum number of group_by(s) is 10."
},
{
"key": "tags",
"value": "consectetur consequat dolor",
"description": "Comma-separated list of tags to filter DNS traffic by."
},
{
"key": "limit",
"value": "100",
"description": "The number of aggregated DNS entries to be returned. The maximum value is 7500. The default is 100."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "The Cloud Network Monitoring API allows you to fetch aggregated connections and DNS traffic with their attributes. See the [Cloud Network Monitoring page](https://docs.datadoghq.com/network_monitoring/cloud_network_monitoring/) and [DNS Monitoring page](https://docs.datadoghq.com/network_monitoring/dns/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Cloudflare Integration",
"item": [
{
"name": "List Cloudflare accounts",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts"
]
},
"description": "List Cloudflare accounts."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"name\": \"test-name\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"id\": \"c1a8e059bfd1e911cf10b626340c9a54\",\n \"type\": \"cloudflare-accounts\"\n },\n {\n \"attributes\": {\n \"name\": \"test-name\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"id\": \"c1a8e059bfd1e911cf10b626340c9a54\",\n \"type\": \"cloudflare-accounts\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Add Cloudflare account",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"a94a8fe5ccb19ba61c4c0873d391e987982fbbd3\",\n \"name\": \"test-name\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"type\": \"cloudflare-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts"
]
},
"description": "Create a Cloudflare account."
},
"response": [
{
"name": "CREATED",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"a94a8fe5ccb19ba61c4c0873d391e987982fbbd3\",\n \"name\": \"test-name\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"type\": \"cloudflare-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"test-name\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"id\": \"c1a8e059bfd1e911cf10b626340c9a54\",\n \"type\": \"cloudflare-accounts\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"a94a8fe5ccb19ba61c4c0873d391e987982fbbd3\",\n \"name\": \"test-name\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"type\": \"cloudflare-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"a94a8fe5ccb19ba61c4c0873d391e987982fbbd3\",\n \"name\": \"test-name\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"type\": \"cloudflare-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"a94a8fe5ccb19ba61c4c0873d391e987982fbbd3\",\n \"name\": \"test-name\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"type\": \"cloudflare-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"a94a8fe5ccb19ba61c4c0873d391e987982fbbd3\",\n \"name\": \"test-name\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"type\": \"cloudflare-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get Cloudflare account",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Get a Cloudflare account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"test-name\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"id\": \"c1a8e059bfd1e911cf10b626340c9a54\",\n \"type\": \"cloudflare-accounts\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update Cloudflare account",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"a94a8fe5ccb19ba61c4c0873d391e987982fbbd3\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"type\": \"cloudflare-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Update a Cloudflare account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"a94a8fe5ccb19ba61c4c0873d391e987982fbbd3\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"type\": \"cloudflare-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"test-name\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"id\": \"c1a8e059bfd1e911cf10b626340c9a54\",\n \"type\": \"cloudflare-accounts\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"a94a8fe5ccb19ba61c4c0873d391e987982fbbd3\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"type\": \"cloudflare-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"a94a8fe5ccb19ba61c4c0873d391e987982fbbd3\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"type\": \"cloudflare-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"a94a8fe5ccb19ba61c4c0873d391e987982fbbd3\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"type\": \"cloudflare-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"a94a8fe5ccb19ba61c4c0873d391e987982fbbd3\",\n \"email\": \"test-email@example.com\",\n \"resources\": [\n \"web\",\n \"dns\"\n ],\n \"zones\": [\n \"zone_id_1\",\n \"zone_id_2\"\n ]\n },\n \"type\": \"cloudflare-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete Cloudflare account",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete a Cloudflare account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/cloudflare/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"cloudflare",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Manage your Datadog Cloudflare integration directly through the Datadog API. See the [Cloudflare integration page](https://docs.datadoghq.com/integrations/cloudflare/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Confluent Cloud",
"item": [
{
"name": "Update resource in Confluent account",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource-id-123\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
},
{
"key": "resource_id",
"value": "pariatur consequat"
}
]
},
"description": "Update a Confluent resource with the provided resource id for the account associated with the provided account ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource-id-123\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "resource_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource_id_abc123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource_id_abc123\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource-id-123\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "resource_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource-id-123\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "resource_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource-id-123\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "resource_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource-id-123\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "resource_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get resource from Confluent account",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
},
{
"key": "resource_id",
"value": "pariatur consequat"
}
]
},
"description": "Get a Confluent resource with the provided resource id for the account associated with the provided account ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "resource_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource_id_abc123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource_id_abc123\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "resource_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "resource_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "resource_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "resource_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete resource from Confluent account",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
},
{
"key": "resource_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete a Confluent resource with the provided resource id for the account associated with the provided account ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "resource_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "resource_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "resource_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "resource_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources",
":resource_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "resource_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Add resource to Confluent account",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource-id-123\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Create a Confluent resource for the account associated with the provided ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource-id-123\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource_id_abc123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource_id_abc123\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource-id-123\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource-id-123\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource-id-123\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource-id-123\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List Confluent Account resources",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Get a Confluent resource for the account associated with the provided ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource_id_abc123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource_id_abc123\"\n },\n {\n \"attributes\": {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource_id_abc123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-resources\",\n \"id\": \"resource_id_abc123\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id",
"resources"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update Confluent account",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"api_secret\": \"test-api-secret-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Update the Confluent account with the provided account ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"api_secret\": \"test-api-secret-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"resources\": [\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource_id_abc123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource_id_abc123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ],\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"id\": \"account_id_abc123\",\n \"type\": \"confluent-cloud-accounts\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"api_secret\": \"test-api-secret-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"api_secret\": \"test-api-secret-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"api_secret\": \"test-api-secret-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"api_secret\": \"test-api-secret-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get Confluent account",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Get the Confluent account with the provided account ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"resources\": [\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource_id_abc123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource_id_abc123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ],\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"id\": \"account_id_abc123\",\n \"type\": \"confluent-cloud-accounts\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete Confluent account",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete a Confluent account with the provided account ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Add Confluent account",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"api_secret\": \"test-api-secret-123\",\n \"resources\": [\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource-id-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource-id-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ],\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts"
]
},
"description": "Create a Confluent account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"api_secret\": \"test-api-secret-123\",\n \"resources\": [\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource-id-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource-id-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ],\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"resources\": [\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource_id_abc123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource_id_abc123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ],\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"id\": \"account_id_abc123\",\n \"type\": \"confluent-cloud-accounts\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"api_secret\": \"test-api-secret-123\",\n \"resources\": [\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource-id-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource-id-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ],\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"api_secret\": \"test-api-secret-123\",\n \"resources\": [\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource-id-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource-id-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ],\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"api_secret\": \"test-api-secret-123\",\n \"resources\": [\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource-id-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource-id-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ],\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"api_secret\": \"test-api-secret-123\",\n \"resources\": [\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource-id-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource-id-123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ],\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"type\": \"confluent-cloud-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List Confluent accounts",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts"
]
},
"description": "List Confluent accounts."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"resources\": [\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource_id_abc123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource_id_abc123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ],\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"id\": \"account_id_abc123\",\n \"type\": \"confluent-cloud-accounts\"\n },\n {\n \"attributes\": {\n \"api_key\": \"TESTAPIKEY123\",\n \"resources\": [\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource_id_abc123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"resource_type\": \"kafka\",\n \"enable_custom_metrics\": false,\n \"id\": \"resource_id_abc123\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ],\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n \"id\": \"account_id_abc123\",\n \"type\": \"confluent-cloud-accounts\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/confluent-cloud/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"confluent-cloud",
"accounts"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Manage your Datadog Confluent Cloud integration accounts and account resources directly through the Datadog API. See the [Confluent Cloud page](https://docs.datadoghq.com/integrations/confluent_cloud/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Container Images",
"item": [
{
"name": "Get all Container Images",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/container_images",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"container_images"
],
"query": [
{
"key": "filter[tags]",
"value": "short_image:redis,status:running",
"description": "Comma-separated list of tags to filter Container Images by.",
"disabled": true
},
{
"key": "group_by",
"value": "registry,image_tags",
"description": "Comma-separated list of tags to group Container Images by.",
"disabled": true
},
{
"key": "sort",
"value": "container_count",
"description": "Attribute to sort Container Images by.",
"disabled": true
},
{
"key": "page[size]",
"value": "1000",
"description": "Maximum number of results returned.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "pariatur consequat",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.pagination.next_cursor`.",
"disabled": true
}
]
},
"description": "Get all Container Images for your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/container_images",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"container_images"
],
"query": [
{
"key": "filter[tags]",
"value": "short_image:redis,status:running",
"description": "Comma-separated list of tags to filter Container Images by.",
"disabled": true
},
{
"key": "group_by",
"value": "registry,image_tags",
"description": "Comma-separated list of tags to group Container Images by.",
"disabled": true
},
{
"key": "sort",
"value": "container_count",
"description": "Attribute to sort Container Images by.",
"disabled": true
},
{
"key": "page[size]",
"value": "1000",
"description": "Maximum number of results returned.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "pariatur consequat",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.pagination.next_cursor`.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"container_count\": 83395304,\n \"image_flavors\": [\n {\n \"built_at\": \"pariatur sit labore commodo\",\n \"os_architecture\": \"dolore \",\n \"os_name\": \"id est ut\",\n \"os_version\": \"occaecat\",\n \"size\": -15722494\n },\n {\n \"built_at\": \"id\",\n \"os_architecture\": \"deserunt\",\n \"os_name\": \"quis in esse ut amet\",\n \"os_version\": \"cupid\",\n \"size\": 42967562\n }\n ],\n \"image_tags\": [\n \"Lorem proident Excepteur tempor\",\n \"ullamco sunt eiusmod\"\n ],\n \"images_built_at\": [\n \"ut occaecat et voluptat\",\n \"dolore\"\n ],\n \"name\": \"labore sunt\",\n \"os_architectures\": [\n \"amd64\",\n \"amd64\"\n ],\n \"os_names\": [\n \"linux\",\n \"linux\"\n ],\n \"os_versions\": [\n \"Ut\",\n \"ut adipisicing pariatur aliqua\"\n ],\n \"published_at\": \"ipsum eiusmod aute\",\n \"registry\": \"ea veniam dolor sit ad\",\n \"repo_digest\": \"in elit\",\n \"repository\": \"ad deserunt veniam Ut\",\n \"short_image\": \"qui commodo\",\n \"sizes\": [\n 5866265,\n -23217186\n ],\n \"sources\": [\n \"occaecat in ea Lorem culpa\",\n \"elit labore eu consequat\"\n ],\n \"tags\": [\n \"laborum irure enim\",\n \"magna\"\n ],\n \"vulnerability_count\": {\n \"asset_id\": \"consectetur ut officia\",\n \"critical\": 2421307,\n \"high\": 8248750,\n \"low\": -9333311,\n \"medium\": 35469251,\n \"none\": -55354970,\n \"unknown\": -34645275\n }\n },\n \"id\": \"dolore adipisicing\",\n \"type\": \"container_image\"\n },\n {\n \"attributes\": {\n \"container_count\": -93137991,\n \"image_flavors\": [\n {\n \"built_at\": \"eu ullamco et tempor incididunt\",\n \"os_architecture\": \"aliqua tempor in quis\",\n \"os_name\": \"sunt\",\n \"os_version\": \"minim ullamco quis dolore\",\n \"size\": -51068253\n },\n {\n \"built_at\": \"ipsum esse\",\n \"os_architecture\": \"anim commodo ad proident\",\n \"os_name\": \"qui reprehenderit\",\n \"os_version\": \"ad labore tempor fugiat\",\n \"size\": 80828788\n }\n ],\n \"image_tags\": [\n \"fugiat eu velit ullamc\",\n \"nisi reprehenderit\"\n ],\n \"images_built_at\": [\n \"enim Lorem laboris pariatur\",\n \"esse\"\n ],\n \"name\": \"nulla dolore labore anim\",\n \"os_architectures\": [\n \"amd64\",\n \"amd64\"\n ],\n \"os_names\": [\n \"linux\",\n \"linux\"\n ],\n \"os_versions\": [\n \"nulla ea enim\",\n \"qui ullamco sed adipisicing\"\n ],\n \"published_at\": \"consectetur Lorem adipisicing reprehenderit\",\n \"registry\": \"quis non labore in\",\n \"repo_digest\": \"irure aliquip officia\",\n \"repository\": \"adipisicing Duis\",\n \"short_image\": \"si\",\n \"sizes\": [\n -1790351,\n 92675202\n ],\n \"sources\": [\n \"dolor laboris ullamco aliqua\",\n \"ut culpa laboris consectetur anim\"\n ],\n \"tags\": [\n \"consectetur qui\",\n \"et\"\n ],\n \"vulnerability_count\": {\n \"asset_id\": \"occaecat in reprehenderit aliqua\",\n \"critical\": 74849913,\n \"high\": 41705598,\n \"low\": 32420708,\n \"medium\": 21829495,\n \"none\": 501732,\n \"unknown\": -44876298\n }\n },\n \"id\": \"amet dolore ullamco\",\n \"type\": \"container_image\"\n }\n ],\n \"links\": {\n \"first\": \"officia eu\",\n \"last\": \"voluptate\",\n \"next\": \"Lorem mollit s\",\n \"prev\": \"est mollit\",\n \"self\": \"cupid\"\n },\n \"meta\": {\n \"pagination\": {\n \"cursor\": \"adipisicing voluptate culpa ullamco\",\n \"limit\": 5141,\n \"next_cursor\": \"eiusm\",\n \"prev_cursor\": \"cillum cup\",\n \"total\": 50593531,\n \"type\": \"cursor_limit\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/container_images",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"container_images"
],
"query": [
{
"key": "filter[tags]",
"value": "short_image:redis,status:running",
"description": "Comma-separated list of tags to filter Container Images by.",
"disabled": true
},
{
"key": "group_by",
"value": "registry,image_tags",
"description": "Comma-separated list of tags to group Container Images by.",
"disabled": true
},
{
"key": "sort",
"value": "container_count",
"description": "Attribute to sort Container Images by.",
"disabled": true
},
{
"key": "page[size]",
"value": "1000",
"description": "Maximum number of results returned.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "pariatur consequat",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.pagination.next_cursor`.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/container_images",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"container_images"
],
"query": [
{
"key": "filter[tags]",
"value": "short_image:redis,status:running",
"description": "Comma-separated list of tags to filter Container Images by.",
"disabled": true
},
{
"key": "group_by",
"value": "registry,image_tags",
"description": "Comma-separated list of tags to group Container Images by.",
"disabled": true
},
{
"key": "sort",
"value": "container_count",
"description": "Attribute to sort Container Images by.",
"disabled": true
},
{
"key": "page[size]",
"value": "1000",
"description": "Maximum number of results returned.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "pariatur consequat",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.pagination.next_cursor`.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/container_images",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"container_images"
],
"query": [
{
"key": "filter[tags]",
"value": "short_image:redis,status:running",
"description": "Comma-separated list of tags to filter Container Images by.",
"disabled": true
},
{
"key": "group_by",
"value": "registry,image_tags",
"description": "Comma-separated list of tags to group Container Images by.",
"disabled": true
},
{
"key": "sort",
"value": "container_count",
"description": "Attribute to sort Container Images by.",
"disabled": true
},
{
"key": "page[size]",
"value": "1000",
"description": "Maximum number of results returned.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "pariatur consequat",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.pagination.next_cursor`.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "The Container Images API allows you to query Container Image data for your organization. See the [Container Images View page](https://docs.datadoghq.com/infrastructure/containers/container_images/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Containers",
"item": [
{
"name": "Get All Containers",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/containers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"containers"
],
"query": [
{
"key": "filter[tags]",
"value": "env:prod,short_image:cassandra",
"description": "Comma-separated list of tags to filter containers by.",
"disabled": true
},
{
"key": "group_by",
"value": "datacenter,cluster",
"description": "Comma-separated list of tags to group containers by.",
"disabled": true
},
{
"key": "sort",
"value": "started_at",
"description": "Attribute to sort containers by.",
"disabled": true
},
{
"key": "page[size]",
"value": "1000",
"description": "Maximum number of results returned.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "pariatur consequat",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.pagination.next_cursor`.",
"disabled": true
}
]
},
"description": "Get all containers for your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/containers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"containers"
],
"query": [
{
"key": "filter[tags]",
"value": "env:prod,short_image:cassandra",
"description": "Comma-separated list of tags to filter containers by.",
"disabled": true
},
{
"key": "group_by",
"value": "datacenter,cluster",
"description": "Comma-separated list of tags to group containers by.",
"disabled": true
},
{
"key": "sort",
"value": "started_at",
"description": "Attribute to sort containers by.",
"disabled": true
},
{
"key": "page[size]",
"value": "1000",
"description": "Maximum number of results returned.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "pariatur consequat",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.pagination.next_cursor`.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"container_id\": \"fugiat laborum sed elit\",\n \"created_at\": \"occaecat\",\n \"host\": \"officia deserunt\",\n \"image_digest\": \"deserunt Ut sunt occaecat\",\n \"image_name\": \"velit laborum ut\",\n \"image_tags\": [\n \"enim sunt Excepteur pariatur\",\n \"occaecat fugiat elit\"\n ],\n \"name\": \"commodo reprehenderit aute nisi\",\n \"started_at\": \"minim ipsum ad Excepteur\",\n \"state\": \"commodo mollit exercitation cillum\",\n \"tags\": [\n \"ad esse laboris reprehenderit\",\n \"culpa in cillum\"\n ]\n },\n \"id\": \"occaecat cillum veniam\",\n \"type\": \"container\"\n },\n {\n \"attributes\": {\n \"container_id\": \"eiusmod magna ut anim\",\n \"created_at\": \"id sit in in velit\",\n \"host\": \"nisi deserunt\",\n \"image_digest\": \"dolor cillum magna\",\n \"image_name\": \"consectetur mollit Lorem laborum in\",\n \"image_tags\": [\n \"exercitation Duis cillum eu\",\n \"laboris irure magna amet\"\n ],\n \"name\": \"sunt officia in cupidatat\",\n \"started_at\": \"magna eu\",\n \"state\": \"amet sed aliqua sint\",\n \"tags\": [\n \"ut Lorem mollit labore\",\n \"quis deserunt anim irure\"\n ]\n },\n \"id\": \"Duis ut incididunt laborum\",\n \"type\": \"container\"\n }\n ],\n \"links\": {\n \"first\": \"ex commodo sit\",\n \"last\": \"cupidatat ipsum pariatur\",\n \"next\": \"non aliquip\",\n \"prev\": \"fugiat ex\",\n \"self\": \"ipsum nisi sunt qui\"\n },\n \"meta\": {\n \"pagination\": {\n \"cursor\": \"labore incididunt irure\",\n \"limit\": 4902,\n \"next_cursor\": \"occaecat\",\n \"prev_cursor\": \"ut fugiat tempor eli\",\n \"total\": 78209577,\n \"type\": \"cursor_limit\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/containers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"containers"
],
"query": [
{
"key": "filter[tags]",
"value": "env:prod,short_image:cassandra",
"description": "Comma-separated list of tags to filter containers by.",
"disabled": true
},
{
"key": "group_by",
"value": "datacenter,cluster",
"description": "Comma-separated list of tags to group containers by.",
"disabled": true
},
{
"key": "sort",
"value": "started_at",
"description": "Attribute to sort containers by.",
"disabled": true
},
{
"key": "page[size]",
"value": "1000",
"description": "Maximum number of results returned.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "pariatur consequat",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.pagination.next_cursor`.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/containers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"containers"
],
"query": [
{
"key": "filter[tags]",
"value": "env:prod,short_image:cassandra",
"description": "Comma-separated list of tags to filter containers by.",
"disabled": true
},
{
"key": "group_by",
"value": "datacenter,cluster",
"description": "Comma-separated list of tags to group containers by.",
"disabled": true
},
{
"key": "sort",
"value": "started_at",
"description": "Attribute to sort containers by.",
"disabled": true
},
{
"key": "page[size]",
"value": "1000",
"description": "Maximum number of results returned.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "pariatur consequat",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.pagination.next_cursor`.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/containers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"containers"
],
"query": [
{
"key": "filter[tags]",
"value": "env:prod,short_image:cassandra",
"description": "Comma-separated list of tags to filter containers by.",
"disabled": true
},
{
"key": "group_by",
"value": "datacenter,cluster",
"description": "Comma-separated list of tags to group containers by.",
"disabled": true
},
{
"key": "sort",
"value": "started_at",
"description": "Attribute to sort containers by.",
"disabled": true
},
{
"key": "page[size]",
"value": "1000",
"description": "Maximum number of results returned.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "pariatur consequat",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.pagination.next_cursor`.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "The Containers API allows you to query container data for your organization. See the [Container Monitoring page](https://docs.datadoghq.com/containers/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "CSM Agents",
"item": [
{
"name": "Get all CSM Agents",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/agents?page=2&size=12&query=hostname:COMP-T2H4J27423&order_direction=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"agents"
],
"query": [
{
"key": "page",
"value": "2",
"description": "The page index for pagination (zero-based)."
},
{
"key": "size",
"value": "12",
"description": "The number of items to include in a single page."
},
{
"key": "query",
"value": "hostname:COMP-T2H4J27423",
"description": "A search query string to filter results (for example, `hostname:COMP-T2H4J27423`)."
},
{
"key": "order_direction",
"value": "asc",
"description": "The sort direction for results. Use `asc` for ascending or `desc` for descending."
}
]
},
"description": "Get the list of all CSM Agents running on your hosts and containers."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/agents?page=2&size=12&query=hostname:COMP-T2H4J27423&order_direction=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"agents"
],
"query": [
{
"key": "page",
"value": "2",
"description": "The page index for pagination (zero-based)."
},
{
"key": "size",
"value": "12",
"description": "The number of items to include in a single page."
},
{
"key": "query",
"value": "hostname:COMP-T2H4J27423",
"description": "A search query string to filter results (for example, `hostname:COMP-T2H4J27423`)."
},
{
"key": "order_direction",
"value": "asc",
"description": "The sort direction for results. Use `asc` for ascending or `desc` for descending."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"agent_version\": \"enim id aliqua\",\n \"aws_fargate\": \"Excepteur cupidatat in exercitation\",\n \"cluster_name\": [\n \"culpa\",\n \"Duis occaecat\"\n ],\n \"datadog_agent\": \"voluptate ut laboris aliqua\",\n \"ecs_fargate_task_arn\": \"est\",\n \"envs\": [\n \"ipsum nulla exercitation\",\n \"labore Ut\"\n ],\n \"host_id\": -48871409,\n \"hostname\": \"Ut pariatur sed irure\",\n \"install_method_installer_version\": \"id nisi\",\n \"install_method_tool\": \"non eiusmod\",\n \"is_csm_vm_containers_enabled\": false,\n \"is_csm_vm_hosts_enabled\": false,\n \"is_cspm_enabled\": true,\n \"is_cws_enabled\": true,\n \"is_cws_remote_configuration_enabled\": false,\n \"is_remote_configuration_enabled\": true,\n \"os\": \"dolor id\"\n },\n \"id\": \"fffffc5505f6a006fdf7cf5aae053653\",\n \"type\": \"datadog_agent\"\n },\n {\n \"attributes\": {\n \"agent_version\": \"eu pariatur\",\n \"aws_fargate\": \"proident nostrud deserun\",\n \"cluster_name\": [\n \"dolore sint cillum Ut\",\n \"adipisicing nostrud dolor\"\n ],\n \"datadog_agent\": \"irure\",\n \"ecs_fargate_task_arn\": \"elit velit\",\n \"envs\": [\n \"est ex\",\n \"eu minim \"\n ],\n \"host_id\": -72084400,\n \"hostname\": \"elit ea do\",\n \"install_method_installer_version\": \"officia minim\",\n \"install_method_tool\": \"voluptate pariatur aute\",\n \"is_csm_vm_containers_enabled\": true,\n \"is_csm_vm_hosts_enabled\": true,\n \"is_cspm_enabled\": true,\n \"is_cws_enabled\": false,\n \"is_cws_remote_configuration_enabled\": true,\n \"is_remote_configuration_enabled\": true,\n \"os\": \"non incididunt fugiat\"\n },\n \"id\": \"fffffc5505f6a006fdf7cf5aae053653\",\n \"type\": \"datadog_agent\"\n }\n ],\n \"meta\": {\n \"page_index\": 0,\n \"page_size\": 10,\n \"total_filtered\": 128697\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/agents?page=2&size=12&query=hostname:COMP-T2H4J27423&order_direction=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"agents"
],
"query": [
{
"key": "page",
"value": "2",
"description": "The page index for pagination (zero-based)."
},
{
"key": "size",
"value": "12",
"description": "The number of items to include in a single page."
},
{
"key": "query",
"value": "hostname:COMP-T2H4J27423",
"description": "A search query string to filter results (for example, `hostname:COMP-T2H4J27423`)."
},
{
"key": "order_direction",
"value": "asc",
"description": "The sort direction for results. Use `asc` for ascending or `desc` for descending."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/agents?page=2&size=12&query=hostname:COMP-T2H4J27423&order_direction=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"agents"
],
"query": [
{
"key": "page",
"value": "2",
"description": "The page index for pagination (zero-based)."
},
{
"key": "size",
"value": "12",
"description": "The number of items to include in a single page."
},
{
"key": "query",
"value": "hostname:COMP-T2H4J27423",
"description": "A search query string to filter results (for example, `hostname:COMP-T2H4J27423`)."
},
{
"key": "order_direction",
"value": "asc",
"description": "The sort direction for results. Use `asc` for ascending or `desc` for descending."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all CSM Serverless Agents",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/serverless/agents?page=2&size=12&query=hostname:COMP-T2H4J27423&order_direction=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"serverless",
"agents"
],
"query": [
{
"key": "page",
"value": "2",
"description": "The page index for pagination (zero-based)."
},
{
"key": "size",
"value": "12",
"description": "The number of items to include in a single page."
},
{
"key": "query",
"value": "hostname:COMP-T2H4J27423",
"description": "A search query string to filter results (for example, `hostname:COMP-T2H4J27423`)."
},
{
"key": "order_direction",
"value": "asc",
"description": "The sort direction for results. Use `asc` for ascending or `desc` for descending."
}
]
},
"description": "Get the list of all CSM Serverless Agents running on your hosts and containers."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/serverless/agents?page=2&size=12&query=hostname:COMP-T2H4J27423&order_direction=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"serverless",
"agents"
],
"query": [
{
"key": "page",
"value": "2",
"description": "The page index for pagination (zero-based)."
},
{
"key": "size",
"value": "12",
"description": "The number of items to include in a single page."
},
{
"key": "query",
"value": "hostname:COMP-T2H4J27423",
"description": "A search query string to filter results (for example, `hostname:COMP-T2H4J27423`)."
},
{
"key": "order_direction",
"value": "asc",
"description": "The sort direction for results. Use `asc` for ascending or `desc` for descending."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"agent_version\": \"enim id aliqua\",\n \"aws_fargate\": \"Excepteur cupidatat in exercitation\",\n \"cluster_name\": [\n \"culpa\",\n \"Duis occaecat\"\n ],\n \"datadog_agent\": \"voluptate ut laboris aliqua\",\n \"ecs_fargate_task_arn\": \"est\",\n \"envs\": [\n \"ipsum nulla exercitation\",\n \"labore Ut\"\n ],\n \"host_id\": -48871409,\n \"hostname\": \"Ut pariatur sed irure\",\n \"install_method_installer_version\": \"id nisi\",\n \"install_method_tool\": \"non eiusmod\",\n \"is_csm_vm_containers_enabled\": false,\n \"is_csm_vm_hosts_enabled\": false,\n \"is_cspm_enabled\": true,\n \"is_cws_enabled\": true,\n \"is_cws_remote_configuration_enabled\": false,\n \"is_remote_configuration_enabled\": true,\n \"os\": \"dolor id\"\n },\n \"id\": \"fffffc5505f6a006fdf7cf5aae053653\",\n \"type\": \"datadog_agent\"\n },\n {\n \"attributes\": {\n \"agent_version\": \"eu pariatur\",\n \"aws_fargate\": \"proident nostrud deserun\",\n \"cluster_name\": [\n \"dolore sint cillum Ut\",\n \"adipisicing nostrud dolor\"\n ],\n \"datadog_agent\": \"irure\",\n \"ecs_fargate_task_arn\": \"elit velit\",\n \"envs\": [\n \"est ex\",\n \"eu minim \"\n ],\n \"host_id\": -72084400,\n \"hostname\": \"elit ea do\",\n \"install_method_installer_version\": \"officia minim\",\n \"install_method_tool\": \"voluptate pariatur aute\",\n \"is_csm_vm_containers_enabled\": true,\n \"is_csm_vm_hosts_enabled\": true,\n \"is_cspm_enabled\": true,\n \"is_cws_enabled\": false,\n \"is_cws_remote_configuration_enabled\": true,\n \"is_remote_configuration_enabled\": true,\n \"os\": \"non incididunt fugiat\"\n },\n \"id\": \"fffffc5505f6a006fdf7cf5aae053653\",\n \"type\": \"datadog_agent\"\n }\n ],\n \"meta\": {\n \"page_index\": 0,\n \"page_size\": 10,\n \"total_filtered\": 128697\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/serverless/agents?page=2&size=12&query=hostname:COMP-T2H4J27423&order_direction=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"serverless",
"agents"
],
"query": [
{
"key": "page",
"value": "2",
"description": "The page index for pagination (zero-based)."
},
{
"key": "size",
"value": "12",
"description": "The number of items to include in a single page."
},
{
"key": "query",
"value": "hostname:COMP-T2H4J27423",
"description": "A search query string to filter results (for example, `hostname:COMP-T2H4J27423`)."
},
{
"key": "order_direction",
"value": "asc",
"description": "The sort direction for results. Use `asc` for ascending or `desc` for descending."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/serverless/agents?page=2&size=12&query=hostname:COMP-T2H4J27423&order_direction=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"serverless",
"agents"
],
"query": [
{
"key": "page",
"value": "2",
"description": "The page index for pagination (zero-based)."
},
{
"key": "size",
"value": "12",
"description": "The number of items to include in a single page."
},
{
"key": "query",
"value": "hostname:COMP-T2H4J27423",
"description": "A search query string to filter results (for example, `hostname:COMP-T2H4J27423`)."
},
{
"key": "order_direction",
"value": "asc",
"description": "The sort direction for results. Use `asc` for ascending or `desc` for descending."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Datadog Cloud Security Management (CSM) delivers real-time threat detection\nand continuous configuration audits across your entire cloud infrastructure,\nall in a unified view for seamless collaboration and faster remediation.\nGo to https://docs.datadoghq.com/security/cloud_security_management to learn more",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "CSM Coverage Analysis",
"item": [
{
"name": "Get the CSM Cloud Accounts Coverage Analysis",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/coverage_analysis/cloud_accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"coverage_analysis",
"cloud_accounts"
]
},
"description": "Get the CSM Coverage Analysis of your Cloud Accounts.\nThis is calculated based on the number of your Cloud Accounts that are\nscanned for security issues."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/coverage_analysis/cloud_accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"coverage_analysis",
"cloud_accounts"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"aws_coverage\": {\n \"configured_resources_count\": 8,\n \"coverage\": 0.8,\n \"partially_configured_resources_count\": 0,\n \"total_resources_count\": 10\n },\n \"azure_coverage\": {\n \"configured_resources_count\": 8,\n \"coverage\": 0.8,\n \"partially_configured_resources_count\": 0,\n \"total_resources_count\": 10\n },\n \"gcp_coverage\": {\n \"configured_resources_count\": 8,\n \"coverage\": 0.8,\n \"partially_configured_resources_count\": 0,\n \"total_resources_count\": 10\n },\n \"org_id\": 123456,\n \"total_coverage\": {\n \"configured_resources_count\": 8,\n \"coverage\": 0.8,\n \"partially_configured_resources_count\": 0,\n \"total_resources_count\": 10\n }\n },\n \"id\": \"66b3c6b5-5c9a-457e-b1c3-f247ca23afa3\",\n \"type\": \"get_cloud_accounts_coverage_analysis_response_public_v0\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/coverage_analysis/cloud_accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"coverage_analysis",
"cloud_accounts"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/coverage_analysis/cloud_accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"coverage_analysis",
"cloud_accounts"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get the CSM Hosts and Containers Coverage Analysis",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/coverage_analysis/hosts_and_containers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"coverage_analysis",
"hosts_and_containers"
]
},
"description": "Get the CSM Coverage Analysis of your Hosts and Containers.\nThis is calculated based on the number of agents running on your Hosts\nand Containers with CSM feature(s) enabled."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/coverage_analysis/hosts_and_containers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"coverage_analysis",
"hosts_and_containers"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"cspm_coverage\": {\n \"configured_resources_count\": 8,\n \"coverage\": 0.8,\n \"partially_configured_resources_count\": 0,\n \"total_resources_count\": 10\n },\n \"cws_coverage\": {\n \"configured_resources_count\": 8,\n \"coverage\": 0.8,\n \"partially_configured_resources_count\": 0,\n \"total_resources_count\": 10\n },\n \"org_id\": 123456,\n \"total_coverage\": {\n \"configured_resources_count\": 8,\n \"coverage\": 0.8,\n \"partially_configured_resources_count\": 0,\n \"total_resources_count\": 10\n },\n \"vm_coverage\": {\n \"configured_resources_count\": 8,\n \"coverage\": 0.8,\n \"partially_configured_resources_count\": 0,\n \"total_resources_count\": 10\n }\n },\n \"id\": \"66b3c6b5-5c9a-457e-b1c3-f247ca23afa3\",\n \"type\": \"get_hosts_and_containers_coverage_analysis_response_public_v0\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/coverage_analysis/hosts_and_containers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"coverage_analysis",
"hosts_and_containers"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/coverage_analysis/hosts_and_containers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"coverage_analysis",
"hosts_and_containers"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get the CSM Serverless Coverage Analysis",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/coverage_analysis/serverless",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"coverage_analysis",
"serverless"
]
},
"description": "Get the CSM Coverage Analysis of your Serverless Resources.\nThis is calculated based on the number of agents running on your Serverless\nResources with CSM feature(s) enabled."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/coverage_analysis/serverless",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"coverage_analysis",
"serverless"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"cws_coverage\": {\n \"configured_resources_count\": 8,\n \"coverage\": 0.8,\n \"partially_configured_resources_count\": 0,\n \"total_resources_count\": 10\n },\n \"org_id\": 123456,\n \"total_coverage\": {\n \"configured_resources_count\": 8,\n \"coverage\": 0.8,\n \"partially_configured_resources_count\": 0,\n \"total_resources_count\": 10\n }\n },\n \"id\": \"66b3c6b5-5c9a-457e-b1c3-f247ca23afa3\",\n \"type\": \"get_serverless_coverage_analysis_response_public_v0\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/coverage_analysis/serverless",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"coverage_analysis",
"serverless"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/csm/onboarding/coverage_analysis/serverless",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"csm",
"onboarding",
"coverage_analysis",
"serverless"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Datadog Cloud Security Management (CSM) delivers real-time threat detection\nand continuous configuration audits across your entire cloud infrastructure,\nall in a unified view for seamless collaboration and faster remediation.\nGo to https://docs.datadoghq.com/security/cloud_security_management to learn more.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "CSM Threats",
"item": [
{
"name": "Get all Workload Protection agent rules",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
]
},
"description": "Get the list of Workload Protection agent rules.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"actions\": [\n {\n \"filter\": \"veniam cillum \",\n \"kill\": {\n \"signal\": \"veniam anim\"\n }\n },\n {\n \"filter\": \"amet esse\",\n \"kill\": {\n \"signal\": \"tempor nulla\"\n }\n }\n ],\n \"agentConstraint\": \"sit\",\n \"category\": \"Process Activity\",\n \"creationAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"creationDate\": 1624366480320,\n \"creator\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"defaultRule\": false,\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"filters\": [\n \"veniam nisi\",\n \"ex veniam do aliqua\"\n ],\n \"name\": \"my_agent_rule\",\n \"product_tags\": [\n \"occaecat voluptate\",\n \"veniam\"\n ],\n \"updateAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"updateDate\": 1624366480320,\n \"updatedAt\": 1624366480320,\n \"updater\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"version\": 23\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"agent_rule\"\n },\n {\n \"attributes\": {\n \"actions\": [\n {\n \"filter\": \"ea\",\n \"kill\": {\n \"signal\": \"voluptate\"\n }\n },\n {\n \"filter\": \"Lorem fugiat\",\n \"kill\": {\n \"signal\": \"dolore in nostrud\"\n }\n }\n ],\n \"agentConstraint\": \"commodo et sed ea\",\n \"category\": \"Process Activity\",\n \"creationAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"creationDate\": 1624366480320,\n \"creator\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"defaultRule\": false,\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"filters\": [\n \"irure sit voluptate dolore veniam\",\n \"occaecat nostrud\"\n ],\n \"name\": \"my_agent_rule\",\n \"product_tags\": [\n \"exercitation eu dolor adipisicing eiusmod\",\n \"dolor qui nisi\"\n ],\n \"updateAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"updateDate\": 1624366480320,\n \"updatedAt\": 1624366480320,\n \"updater\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"version\": 23\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"agent_rule\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a Workload Protection agent rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id",
"value": "3b5-v82-ns6"
}
]
},
"description": "Get the details of a specific Workload Protection agent rule.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"actions\": [\n {\n \"filter\": \"consectetur magna cupidatat\",\n \"kill\": {\n \"signal\": \"nulla laborum eiusmod\"\n }\n },\n {\n \"filter\": \"cupid\",\n \"kill\": {\n \"signal\": \"quis nostrud esse\"\n }\n }\n ],\n \"agentConstraint\": \"in\",\n \"category\": \"Process Activity\",\n \"creationAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"creationDate\": 1624366480320,\n \"creator\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"defaultRule\": false,\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"filters\": [\n \"sed nisi eu\",\n \"amet \"\n ],\n \"name\": \"my_agent_rule\",\n \"product_tags\": [\n \"eu quis\",\n \"voluptate et Duis\"\n ],\n \"updateAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"updateDate\": 1624366480320,\n \"updatedAt\": 1624366480320,\n \"updater\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"version\": 23\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"agent_rule\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a Workload Protection agent rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"filters\": [\n \"aute\",\n \"Ut irure sed \"\n ],\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"Lorem occaecat pariatur dolor\",\n \"magna nisi esse id Duis\"\n ]\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules"
]
},
"description": "Create a new Workload Protection agent rule with the given parameters.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"filters\": [\n \"aute\",\n \"Ut irure sed \"\n ],\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"Lorem occaecat pariatur dolor\",\n \"magna nisi esse id Duis\"\n ]\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"actions\": [\n {\n \"filter\": \"consectetur magna cupidatat\",\n \"kill\": {\n \"signal\": \"nulla laborum eiusmod\"\n }\n },\n {\n \"filter\": \"cupid\",\n \"kill\": {\n \"signal\": \"quis nostrud esse\"\n }\n }\n ],\n \"agentConstraint\": \"in\",\n \"category\": \"Process Activity\",\n \"creationAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"creationDate\": 1624366480320,\n \"creator\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"defaultRule\": false,\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"filters\": [\n \"sed nisi eu\",\n \"amet \"\n ],\n \"name\": \"my_agent_rule\",\n \"product_tags\": [\n \"eu quis\",\n \"voluptate et Duis\"\n ],\n \"updateAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"updateDate\": 1624366480320,\n \"updatedAt\": 1624366480320,\n \"updater\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"version\": 23\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"agent_rule\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"filters\": [\n \"aute\",\n \"Ut irure sed \"\n ],\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"Lorem occaecat pariatur dolor\",\n \"magna nisi esse id Duis\"\n ]\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"filters\": [\n \"aute\",\n \"Ut irure sed \"\n ],\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"Lorem occaecat pariatur dolor\",\n \"magna nisi esse id Duis\"\n ]\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"filters\": [\n \"aute\",\n \"Ut irure sed \"\n ],\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"Lorem occaecat pariatur dolor\",\n \"magna nisi esse id Duis\"\n ]\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"filters\": [\n \"aute\",\n \"Ut irure sed \"\n ],\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"Lorem occaecat pariatur dolor\",\n \"magna nisi esse id Duis\"\n ]\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a Workload Protection agent rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"dolore velit in non sit\",\n \"ut qui sint Duis\"\n ]\n },\n \"type\": \"agent_rule\",\n \"id\": \"3dd-0uc-h1s\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id",
"value": "3b5-v82-ns6"
}
]
},
"description": "Update a specific Workload Protection Agent rule.\nReturns the agent rule object when the request is successful.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"dolore velit in non sit\",\n \"ut qui sint Duis\"\n ]\n },\n \"type\": \"agent_rule\",\n \"id\": \"3dd-0uc-h1s\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"actions\": [\n {\n \"filter\": \"consectetur magna cupidatat\",\n \"kill\": {\n \"signal\": \"nulla laborum eiusmod\"\n }\n },\n {\n \"filter\": \"cupid\",\n \"kill\": {\n \"signal\": \"quis nostrud esse\"\n }\n }\n ],\n \"agentConstraint\": \"in\",\n \"category\": \"Process Activity\",\n \"creationAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"creationDate\": 1624366480320,\n \"creator\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"defaultRule\": false,\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"filters\": [\n \"sed nisi eu\",\n \"amet \"\n ],\n \"name\": \"my_agent_rule\",\n \"product_tags\": [\n \"eu quis\",\n \"voluptate et Duis\"\n ],\n \"updateAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"updateDate\": 1624366480320,\n \"updatedAt\": 1624366480320,\n \"updater\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"version\": 23\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"agent_rule\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"dolore velit in non sit\",\n \"ut qui sint Duis\"\n ]\n },\n \"type\": \"agent_rule\",\n \"id\": \"3dd-0uc-h1s\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"dolore velit in non sit\",\n \"ut qui sint Duis\"\n ]\n },\n \"type\": \"agent_rule\",\n \"id\": \"3dd-0uc-h1s\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"dolore velit in non sit\",\n \"ut qui sint Duis\"\n ]\n },\n \"type\": \"agent_rule\",\n \"id\": \"3dd-0uc-h1s\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"dolore velit in non sit\",\n \"ut qui sint Duis\"\n ]\n },\n \"type\": \"agent_rule\",\n \"id\": \"3dd-0uc-h1s\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"dolore velit in non sit\",\n \"ut qui sint Duis\"\n ]\n },\n \"type\": \"agent_rule\",\n \"id\": \"3dd-0uc-h1s\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a Workload Protection agent rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id",
"value": "3b5-v82-ns6"
}
]
},
"description": "Delete a specific Workload Protection agent rule.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id?policy_id=6517fcc1-cec7-4394-a655-8d6e9d085255",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"agent_rules",
":agent_rule_id"
],
"query": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255",
"description": "The ID of the Agent policy"
}
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all Workload Protection policies",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy"
]
},
"description": "Get the list of Workload Protection policies.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"blockingRulesCount\": 100,\n \"datadogManaged\": false,\n \"description\": \"My agent policy\",\n \"disabledRulesCount\": 100,\n \"enabled\": true,\n \"hostTags\": [\n \"dolor\",\n \"ea labore\"\n ],\n \"hostTagsLists\": [\n [\n \"ut\",\n \"pariatur magna est sed\"\n ],\n [\n \"sunt amet dolor incididunt exercitation\",\n \"ut magna et\"\n ]\n ],\n \"monitoringRulesCount\": 100,\n \"name\": \"my_agent_policy\",\n \"policyVersion\": \"1\",\n \"priority\": 10,\n \"ruleCount\": 100,\n \"updateDate\": 1624366480320,\n \"updatedAt\": 1624366480320,\n \"updater\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n }\n },\n \"id\": \"6517fcc1-cec7-4394-a655-8d6e9d085255\",\n \"type\": \"policy\"\n },\n {\n \"attributes\": {\n \"blockingRulesCount\": 100,\n \"datadogManaged\": false,\n \"description\": \"My agent policy\",\n \"disabledRulesCount\": 100,\n \"enabled\": true,\n \"hostTags\": [\n \"aliquip\",\n \"laboris\"\n ],\n \"hostTagsLists\": [\n [\n \"dolor in\",\n \"culpa magna nostrud dolore dolor\"\n ],\n [\n \"id\",\n \"in in aliquip incididunt\"\n ]\n ],\n \"monitoringRulesCount\": 100,\n \"name\": \"my_agent_policy\",\n \"policyVersion\": \"1\",\n \"priority\": 10,\n \"ruleCount\": 100,\n \"updateDate\": 1624366480320,\n \"updatedAt\": 1624366480320,\n \"updater\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n }\n },\n \"id\": \"6517fcc1-cec7-4394-a655-8d6e9d085255\",\n \"type\": \"policy\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a Workload Protection policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255"
}
]
},
"description": "Get the details of a specific Workload Protection policy.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"blockingRulesCount\": 100,\n \"datadogManaged\": false,\n \"description\": \"My agent policy\",\n \"disabledRulesCount\": 100,\n \"enabled\": true,\n \"hostTags\": [\n \"proident in quis\",\n \"non voluptate Lorem culpa\"\n ],\n \"hostTagsLists\": [\n [\n \"sit est\",\n \"aliquip \"\n ],\n [\n \"ad\",\n \"quis incididunt magna\"\n ]\n ],\n \"monitoringRulesCount\": 100,\n \"name\": \"my_agent_policy\",\n \"policyVersion\": \"1\",\n \"priority\": 10,\n \"ruleCount\": 100,\n \"updateDate\": 1624366480320,\n \"updatedAt\": 1624366480320,\n \"updater\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n }\n },\n \"id\": \"6517fcc1-cec7-4394-a655-8d6e9d085255\",\n \"type\": \"policy\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a Workload Protection policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_policy\",\n \"description\": \"My agent policy\",\n \"enabled\": true,\n \"hostTags\": [\n \"ex veniam\",\n \"nisi do ut eu\"\n ],\n \"hostTagsLists\": [\n [\n \"Lorem proident commodo\",\n \"pariatur velit est ullamco\"\n ],\n [\n \"Ut tempor anim\",\n \"esse est aliquip dolore\"\n ]\n ]\n },\n \"type\": \"policy\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy"
]
},
"description": "Create a new Workload Protection policy with the given parameters.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_policy\",\n \"description\": \"My agent policy\",\n \"enabled\": true,\n \"hostTags\": [\n \"ex veniam\",\n \"nisi do ut eu\"\n ],\n \"hostTagsLists\": [\n [\n \"Lorem proident commodo\",\n \"pariatur velit est ullamco\"\n ],\n [\n \"Ut tempor anim\",\n \"esse est aliquip dolore\"\n ]\n ]\n },\n \"type\": \"policy\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"blockingRulesCount\": 100,\n \"datadogManaged\": false,\n \"description\": \"My agent policy\",\n \"disabledRulesCount\": 100,\n \"enabled\": true,\n \"hostTags\": [\n \"proident in quis\",\n \"non voluptate Lorem culpa\"\n ],\n \"hostTagsLists\": [\n [\n \"sit est\",\n \"aliquip \"\n ],\n [\n \"ad\",\n \"quis incididunt magna\"\n ]\n ],\n \"monitoringRulesCount\": 100,\n \"name\": \"my_agent_policy\",\n \"policyVersion\": \"1\",\n \"priority\": 10,\n \"ruleCount\": 100,\n \"updateDate\": 1624366480320,\n \"updatedAt\": 1624366480320,\n \"updater\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n }\n },\n \"id\": \"6517fcc1-cec7-4394-a655-8d6e9d085255\",\n \"type\": \"policy\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_policy\",\n \"description\": \"My agent policy\",\n \"enabled\": true,\n \"hostTags\": [\n \"ex veniam\",\n \"nisi do ut eu\"\n ],\n \"hostTagsLists\": [\n [\n \"Lorem proident commodo\",\n \"pariatur velit est ullamco\"\n ],\n [\n \"Ut tempor anim\",\n \"esse est aliquip dolore\"\n ]\n ]\n },\n \"type\": \"policy\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_policy\",\n \"description\": \"My agent policy\",\n \"enabled\": true,\n \"hostTags\": [\n \"ex veniam\",\n \"nisi do ut eu\"\n ],\n \"hostTagsLists\": [\n [\n \"Lorem proident commodo\",\n \"pariatur velit est ullamco\"\n ],\n [\n \"Ut tempor anim\",\n \"esse est aliquip dolore\"\n ]\n ]\n },\n \"type\": \"policy\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_policy\",\n \"description\": \"My agent policy\",\n \"enabled\": true,\n \"hostTags\": [\n \"ex veniam\",\n \"nisi do ut eu\"\n ],\n \"hostTagsLists\": [\n [\n \"Lorem proident commodo\",\n \"pariatur velit est ullamco\"\n ],\n [\n \"Ut tempor anim\",\n \"esse est aliquip dolore\"\n ]\n ]\n },\n \"type\": \"policy\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_policy\",\n \"description\": \"My agent policy\",\n \"enabled\": true,\n \"hostTags\": [\n \"ex veniam\",\n \"nisi do ut eu\"\n ],\n \"hostTagsLists\": [\n [\n \"Lorem proident commodo\",\n \"pariatur velit est ullamco\"\n ],\n [\n \"Ut tempor anim\",\n \"esse est aliquip dolore\"\n ]\n ]\n },\n \"type\": \"policy\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a Workload Protection policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My agent policy\",\n \"enabled\": true,\n \"hostTags\": [\n \"mollit occaecat anim in\",\n \"veniam sit officia et sed\"\n ],\n \"hostTagsLists\": [\n [\n \"officia pariatur\",\n \"in sed et est\"\n ],\n [\n \"dolor qui temp\",\n \"dolor id adipisicing eiusmod fug\"\n ]\n ],\n \"name\": \"my_agent_policy\"\n },\n \"type\": \"policy\",\n \"id\": \"6517fcc1-cec7-4394-a655-8d6e9d085255\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255"
}
]
},
"description": "Update a specific Workload Protection policy.\nReturns the policy object when the request is successful.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My agent policy\",\n \"enabled\": true,\n \"hostTags\": [\n \"mollit occaecat anim in\",\n \"veniam sit officia et sed\"\n ],\n \"hostTagsLists\": [\n [\n \"officia pariatur\",\n \"in sed et est\"\n ],\n [\n \"dolor qui temp\",\n \"dolor id adipisicing eiusmod fug\"\n ]\n ],\n \"name\": \"my_agent_policy\"\n },\n \"type\": \"policy\",\n \"id\": \"6517fcc1-cec7-4394-a655-8d6e9d085255\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"blockingRulesCount\": 100,\n \"datadogManaged\": false,\n \"description\": \"My agent policy\",\n \"disabledRulesCount\": 100,\n \"enabled\": true,\n \"hostTags\": [\n \"proident in quis\",\n \"non voluptate Lorem culpa\"\n ],\n \"hostTagsLists\": [\n [\n \"sit est\",\n \"aliquip \"\n ],\n [\n \"ad\",\n \"quis incididunt magna\"\n ]\n ],\n \"monitoringRulesCount\": 100,\n \"name\": \"my_agent_policy\",\n \"policyVersion\": \"1\",\n \"priority\": 10,\n \"ruleCount\": 100,\n \"updateDate\": 1624366480320,\n \"updatedAt\": 1624366480320,\n \"updater\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n }\n },\n \"id\": \"6517fcc1-cec7-4394-a655-8d6e9d085255\",\n \"type\": \"policy\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My agent policy\",\n \"enabled\": true,\n \"hostTags\": [\n \"mollit occaecat anim in\",\n \"veniam sit officia et sed\"\n ],\n \"hostTagsLists\": [\n [\n \"officia pariatur\",\n \"in sed et est\"\n ],\n [\n \"dolor qui temp\",\n \"dolor id adipisicing eiusmod fug\"\n ]\n ],\n \"name\": \"my_agent_policy\"\n },\n \"type\": \"policy\",\n \"id\": \"6517fcc1-cec7-4394-a655-8d6e9d085255\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My agent policy\",\n \"enabled\": true,\n \"hostTags\": [\n \"mollit occaecat anim in\",\n \"veniam sit officia et sed\"\n ],\n \"hostTagsLists\": [\n [\n \"officia pariatur\",\n \"in sed et est\"\n ],\n [\n \"dolor qui temp\",\n \"dolor id adipisicing eiusmod fug\"\n ]\n ],\n \"name\": \"my_agent_policy\"\n },\n \"type\": \"policy\",\n \"id\": \"6517fcc1-cec7-4394-a655-8d6e9d085255\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My agent policy\",\n \"enabled\": true,\n \"hostTags\": [\n \"mollit occaecat anim in\",\n \"veniam sit officia et sed\"\n ],\n \"hostTagsLists\": [\n [\n \"officia pariatur\",\n \"in sed et est\"\n ],\n [\n \"dolor qui temp\",\n \"dolor id adipisicing eiusmod fug\"\n ]\n ],\n \"name\": \"my_agent_policy\"\n },\n \"type\": \"policy\",\n \"id\": \"6517fcc1-cec7-4394-a655-8d6e9d085255\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My agent policy\",\n \"enabled\": true,\n \"hostTags\": [\n \"mollit occaecat anim in\",\n \"veniam sit officia et sed\"\n ],\n \"hostTagsLists\": [\n [\n \"officia pariatur\",\n \"in sed et est\"\n ],\n [\n \"dolor qui temp\",\n \"dolor id adipisicing eiusmod fug\"\n ]\n ],\n \"name\": \"my_agent_policy\"\n },\n \"type\": \"policy\",\n \"id\": \"6517fcc1-cec7-4394-a655-8d6e9d085255\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My agent policy\",\n \"enabled\": true,\n \"hostTags\": [\n \"mollit occaecat anim in\",\n \"veniam sit officia et sed\"\n ],\n \"hostTagsLists\": [\n [\n \"officia pariatur\",\n \"in sed et est\"\n ],\n [\n \"dolor qui temp\",\n \"dolor id adipisicing eiusmod fug\"\n ]\n ],\n \"name\": \"my_agent_policy\"\n },\n \"type\": \"policy\",\n \"id\": \"6517fcc1-cec7-4394-a655-8d6e9d085255\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a Workload Protection policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id",
"value": "6517fcc1-cec7-4394-a655-8d6e9d085255"
}
]
},
"description": "Delete a specific Workload Protection policy.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Download the Workload Protection policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/zip"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/download",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
"download"
]
},
"description": "The download endpoint generates a Workload Protection policy file from your currently active\nWorkload Protection agent rules, and downloads them as a `.policy` file. This file can then be deployed to\nyour agents to update the policy running in your environment.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/zip"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/download",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
"download"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "application/zip"
}
],
"cookie": [],
"body": "officia ipsum dolo"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/download",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
"download"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/remote_config/products/cws/policy/download",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"remote_config",
"products",
"cws",
"policy",
"download"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Download the Workload Protection policy (US1-FED)",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/yaml"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/cloud_workload/policy/download",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"cloud_workload",
"policy",
"download"
]
},
"description": "The download endpoint generates a Workload Protection policy file from your currently active\nWorkload Protection agent rules, and downloads them as a `.policy` file. This file can then be deployed to\nyour agents to update the policy running in your environment.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/yaml"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/cloud_workload/policy/download",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"cloud_workload",
"policy",
"download"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "application/yaml"
}
],
"cookie": [],
"body": "officia ipsum dolo"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/cloud_workload/policy/download",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"cloud_workload",
"policy",
"download"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/cloud_workload/policy/download",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"cloud_workload",
"policy",
"download"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all Workload Protection agent rules (US1-FED)",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules"
]
},
"description": "Get the list of agent rules.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"actions\": [\n {\n \"filter\": \"veniam cillum \",\n \"kill\": {\n \"signal\": \"veniam anim\"\n }\n },\n {\n \"filter\": \"amet esse\",\n \"kill\": {\n \"signal\": \"tempor nulla\"\n }\n }\n ],\n \"agentConstraint\": \"sit\",\n \"category\": \"Process Activity\",\n \"creationAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"creationDate\": 1624366480320,\n \"creator\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"defaultRule\": false,\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"filters\": [\n \"veniam nisi\",\n \"ex veniam do aliqua\"\n ],\n \"name\": \"my_agent_rule\",\n \"product_tags\": [\n \"occaecat voluptate\",\n \"veniam\"\n ],\n \"updateAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"updateDate\": 1624366480320,\n \"updatedAt\": 1624366480320,\n \"updater\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"version\": 23\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"agent_rule\"\n },\n {\n \"attributes\": {\n \"actions\": [\n {\n \"filter\": \"ea\",\n \"kill\": {\n \"signal\": \"voluptate\"\n }\n },\n {\n \"filter\": \"Lorem fugiat\",\n \"kill\": {\n \"signal\": \"dolore in nostrud\"\n }\n }\n ],\n \"agentConstraint\": \"commodo et sed ea\",\n \"category\": \"Process Activity\",\n \"creationAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"creationDate\": 1624366480320,\n \"creator\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"defaultRule\": false,\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"filters\": [\n \"irure sit voluptate dolore veniam\",\n \"occaecat nostrud\"\n ],\n \"name\": \"my_agent_rule\",\n \"product_tags\": [\n \"exercitation eu dolor adipisicing eiusmod\",\n \"dolor qui nisi\"\n ],\n \"updateAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"updateDate\": 1624366480320,\n \"updatedAt\": 1624366480320,\n \"updater\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"version\": 23\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"agent_rule\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a Workload Protection agent rule (US1-FED)",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id",
"value": "3b5-v82-ns6"
}
]
},
"description": "Get the details of a specific agent rule.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"actions\": [\n {\n \"filter\": \"consectetur magna cupidatat\",\n \"kill\": {\n \"signal\": \"nulla laborum eiusmod\"\n }\n },\n {\n \"filter\": \"cupid\",\n \"kill\": {\n \"signal\": \"quis nostrud esse\"\n }\n }\n ],\n \"agentConstraint\": \"in\",\n \"category\": \"Process Activity\",\n \"creationAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"creationDate\": 1624366480320,\n \"creator\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"defaultRule\": false,\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"filters\": [\n \"sed nisi eu\",\n \"amet \"\n ],\n \"name\": \"my_agent_rule\",\n \"product_tags\": [\n \"eu quis\",\n \"voluptate et Duis\"\n ],\n \"updateAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"updateDate\": 1624366480320,\n \"updatedAt\": 1624366480320,\n \"updater\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"version\": 23\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"agent_rule\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a Workload Protection agent rule (US1-FED)",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"filters\": [\n \"aute\",\n \"Ut irure sed \"\n ],\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"Lorem occaecat pariatur dolor\",\n \"magna nisi esse id Duis\"\n ]\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules"
]
},
"description": "Create a new agent rule with the given parameters.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"filters\": [\n \"aute\",\n \"Ut irure sed \"\n ],\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"Lorem occaecat pariatur dolor\",\n \"magna nisi esse id Duis\"\n ]\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"actions\": [\n {\n \"filter\": \"consectetur magna cupidatat\",\n \"kill\": {\n \"signal\": \"nulla laborum eiusmod\"\n }\n },\n {\n \"filter\": \"cupid\",\n \"kill\": {\n \"signal\": \"quis nostrud esse\"\n }\n }\n ],\n \"agentConstraint\": \"in\",\n \"category\": \"Process Activity\",\n \"creationAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"creationDate\": 1624366480320,\n \"creator\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"defaultRule\": false,\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"filters\": [\n \"sed nisi eu\",\n \"amet \"\n ],\n \"name\": \"my_agent_rule\",\n \"product_tags\": [\n \"eu quis\",\n \"voluptate et Duis\"\n ],\n \"updateAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"updateDate\": 1624366480320,\n \"updatedAt\": 1624366480320,\n \"updater\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"version\": 23\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"agent_rule\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"filters\": [\n \"aute\",\n \"Ut irure sed \"\n ],\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"Lorem occaecat pariatur dolor\",\n \"magna nisi esse id Duis\"\n ]\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"filters\": [\n \"aute\",\n \"Ut irure sed \"\n ],\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"Lorem occaecat pariatur dolor\",\n \"magna nisi esse id Duis\"\n ]\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"filters\": [\n \"aute\",\n \"Ut irure sed \"\n ],\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"Lorem occaecat pariatur dolor\",\n \"magna nisi esse id Duis\"\n ]\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_agent_rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"filters\": [\n \"aute\",\n \"Ut irure sed \"\n ],\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"Lorem occaecat pariatur dolor\",\n \"magna nisi esse id Duis\"\n ]\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a Workload Protection agent rule (US1-FED)",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"dolore velit in non sit\",\n \"ut qui sint Duis\"\n ]\n },\n \"type\": \"agent_rule\",\n \"id\": \"3dd-0uc-h1s\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id",
"value": "3b5-v82-ns6"
}
]
},
"description": "Update a specific agent rule.\nReturns the agent rule object when the request is successful.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"dolore velit in non sit\",\n \"ut qui sint Duis\"\n ]\n },\n \"type\": \"agent_rule\",\n \"id\": \"3dd-0uc-h1s\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"actions\": [\n {\n \"filter\": \"consectetur magna cupidatat\",\n \"kill\": {\n \"signal\": \"nulla laborum eiusmod\"\n }\n },\n {\n \"filter\": \"cupid\",\n \"kill\": {\n \"signal\": \"quis nostrud esse\"\n }\n }\n ],\n \"agentConstraint\": \"in\",\n \"category\": \"Process Activity\",\n \"creationAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"creationDate\": 1624366480320,\n \"creator\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"defaultRule\": false,\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"filters\": [\n \"sed nisi eu\",\n \"amet \"\n ],\n \"name\": \"my_agent_rule\",\n \"product_tags\": [\n \"eu quis\",\n \"voluptate et Duis\"\n ],\n \"updateAuthorUuId\": \"e51c9744-d158-11ec-ad23-da7ad0900002\",\n \"updateDate\": 1624366480320,\n \"updatedAt\": 1624366480320,\n \"updater\": {\n \"handle\": \"datadog.user@example.com\",\n \"name\": \"Datadog User\"\n },\n \"version\": 23\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"agent_rule\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"dolore velit in non sit\",\n \"ut qui sint Duis\"\n ]\n },\n \"type\": \"agent_rule\",\n \"id\": \"3dd-0uc-h1s\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"dolore velit in non sit\",\n \"ut qui sint Duis\"\n ]\n },\n \"type\": \"agent_rule\",\n \"id\": \"3dd-0uc-h1s\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"dolore velit in non sit\",\n \"ut qui sint Duis\"\n ]\n },\n \"type\": \"agent_rule\",\n \"id\": \"3dd-0uc-h1s\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"dolore velit in non sit\",\n \"ut qui sint Duis\"\n ]\n },\n \"type\": \"agent_rule\",\n \"id\": \"3dd-0uc-h1s\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"My Agent rule\",\n \"enabled\": true,\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \"policy_id\": \"a8c8e364-6556-434d-b798-a4c23de29c0b\",\n \"product_tags\": [\n \"dolore velit in non sit\",\n \"ut qui sint Duis\"\n ]\n },\n \"type\": \"agent_rule\",\n \"id\": \"3dd-0uc-h1s\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a Workload Protection agent rule (US1-FED)",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id",
"value": "3b5-v82-ns6"
}
]
},
"description": "Delete a specific agent rule.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Workload Protection monitors file, network, and process activity across your environment to detect real-time threats to your infrastructure. See [Workload Protection](https://docs.datadoghq.com/security/workload_protection/) for more information on setting up Workload Protection.\n\n**Note**: These endpoints are split based on whether you are using the US1-FED site or not. Please reference the specific resource for the site you are using.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Dashboard Lists",
"item": [
{
"name": "Get all dashboard lists",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual"
]
},
"description": "Fetch all of your existing dashboard list definitions."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"dashboard_lists\": [\n {\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"tempor\",\n \"handle\": \"ex ullamco occaecat\",\n \"name\": \"nostrud ea Lorem eu\"\n },\n \"created\": \"1985-09-26T12:56:46.954Z\",\n \"dashboard_count\": -66540670,\n \"id\": -481941,\n \"is_favorite\": false,\n \"modified\": \"1960-04-30T03:38:15.768Z\",\n \"type\": \"manual_dashboard_list\"\n },\n {\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"exercitation\",\n \"handle\": \"in nisi incididunt sunt\",\n \"name\": \"occaecat ex\"\n },\n \"created\": \"2004-09-05T08:55:40.192Z\",\n \"dashboard_count\": 64043891,\n \"id\": 92153132,\n \"is_favorite\": false,\n \"modified\": \"1958-06-15T05:48:50.423Z\",\n \"type\": \"manual_dashboard_list\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get items of a Dashboard List",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id",
"value": "97337406"
}
]
},
"description": "Fetch the dashboard list’s dashboard definitions."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"dashboards\": [],\n \"total\": -87873014\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Add Items to a Dashboard List",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id",
"value": "97337406"
}
]
},
"description": "Add dashboards to an existing dashboard list."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"added_dashboards_to_list\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a dashboard list",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"reprehenderit veniam\",\n \"handle\": \"fugiat ex minim qui\",\n \"name\": \"sint ullamco\"\n },\n \"created\": \"1982-10-23T10:00:36.966Z\",\n \"dashboard_count\": 92719114,\n \"id\": -92359742,\n \"is_favorite\": true,\n \"modified\": \"1948-10-23T05:55:37.830Z\",\n \"type\": \"manual_dashboard_list\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual"
]
},
"description": "Create an empty dashboard list."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"reprehenderit veniam\",\n \"handle\": \"fugiat ex minim qui\",\n \"name\": \"sint ullamco\"\n },\n \"created\": \"1982-10-23T10:00:36.966Z\",\n \"dashboard_count\": 92719114,\n \"id\": -92359742,\n \"is_favorite\": true,\n \"modified\": \"1948-10-23T05:55:37.830Z\",\n \"type\": \"manual_dashboard_list\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"reprehenderit veniam\",\n \"handle\": \"fugiat ex minim qui\",\n \"name\": \"sint ullamco\"\n },\n \"created\": \"1982-10-23T10:00:36.966Z\",\n \"dashboard_count\": 92719114,\n \"id\": -92359742,\n \"is_favorite\": true,\n \"modified\": \"1948-10-23T05:55:37.830Z\",\n \"type\": \"manual_dashboard_list\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"reprehenderit veniam\",\n \"handle\": \"fugiat ex minim qui\",\n \"name\": \"sint ullamco\"\n },\n \"created\": \"1982-10-23T10:00:36.966Z\",\n \"dashboard_count\": 92719114,\n \"id\": -92359742,\n \"is_favorite\": true,\n \"modified\": \"1948-10-23T05:55:37.830Z\",\n \"type\": \"manual_dashboard_list\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"reprehenderit veniam\",\n \"handle\": \"fugiat ex minim qui\",\n \"name\": \"sint ullamco\"\n },\n \"created\": \"1982-10-23T10:00:36.966Z\",\n \"dashboard_count\": 92719114,\n \"id\": -92359742,\n \"is_favorite\": true,\n \"modified\": \"1948-10-23T05:55:37.830Z\",\n \"type\": \"manual_dashboard_list\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"reprehenderit veniam\",\n \"handle\": \"fugiat ex minim qui\",\n \"name\": \"sint ullamco\"\n },\n \"created\": \"1982-10-23T10:00:36.966Z\",\n \"dashboard_count\": 92719114,\n \"id\": -92359742,\n \"is_favorite\": true,\n \"modified\": \"1948-10-23T05:55:37.830Z\",\n \"type\": \"manual_dashboard_list\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a dashboard list",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id",
"value": "-32260706"
}
]
},
"description": "Fetch an existing dashboard list's definition."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"reprehenderit veniam\",\n \"handle\": \"fugiat ex minim qui\",\n \"name\": \"sint ullamco\"\n },\n \"created\": \"1982-10-23T10:00:36.966Z\",\n \"dashboard_count\": 92719114,\n \"id\": -92359742,\n \"is_favorite\": true,\n \"modified\": \"1948-10-23T05:55:37.830Z\",\n \"type\": \"manual_dashboard_list\"\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update items of a dashboard list",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id",
"value": "97337406"
}
]
},
"description": "Update dashboards of an existing dashboard list."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete items from a dashboard list",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id",
"value": "97337406"
}
]
},
"description": "Delete dashboards from an existing dashboard list."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"deleted_dashboards_from_list\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n },\n {\n \"type\": \"host_timeboard\",\n \"id\": \"q5j-nti-fv6\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a dashboard list",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"reprehenderit veniam\",\n \"handle\": \"fugiat ex minim qui\",\n \"name\": \"sint ullamco\"\n },\n \"created\": \"1982-10-23T10:00:36.966Z\",\n \"dashboard_count\": 92719114,\n \"id\": -92359742,\n \"is_favorite\": true,\n \"modified\": \"1948-10-23T05:55:37.830Z\",\n \"type\": \"manual_dashboard_list\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id",
"value": "-32260706"
}
]
},
"description": "Update the name of a dashboard list."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"reprehenderit veniam\",\n \"handle\": \"fugiat ex minim qui\",\n \"name\": \"sint ullamco\"\n },\n \"created\": \"1982-10-23T10:00:36.966Z\",\n \"dashboard_count\": 92719114,\n \"id\": -92359742,\n \"is_favorite\": true,\n \"modified\": \"1948-10-23T05:55:37.830Z\",\n \"type\": \"manual_dashboard_list\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"reprehenderit veniam\",\n \"handle\": \"fugiat ex minim qui\",\n \"name\": \"sint ullamco\"\n },\n \"created\": \"1982-10-23T10:00:36.966Z\",\n \"dashboard_count\": 92719114,\n \"id\": -92359742,\n \"is_favorite\": true,\n \"modified\": \"1948-10-23T05:55:37.830Z\",\n \"type\": \"manual_dashboard_list\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"reprehenderit veniam\",\n \"handle\": \"fugiat ex minim qui\",\n \"name\": \"sint ullamco\"\n },\n \"created\": \"1982-10-23T10:00:36.966Z\",\n \"dashboard_count\": 92719114,\n \"id\": -92359742,\n \"is_favorite\": true,\n \"modified\": \"1948-10-23T05:55:37.830Z\",\n \"type\": \"manual_dashboard_list\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"reprehenderit veniam\",\n \"handle\": \"fugiat ex minim qui\",\n \"name\": \"sint ullamco\"\n },\n \"created\": \"1982-10-23T10:00:36.966Z\",\n \"dashboard_count\": 92719114,\n \"id\": -92359742,\n \"is_favorite\": true,\n \"modified\": \"1948-10-23T05:55:37.830Z\",\n \"type\": \"manual_dashboard_list\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"reprehenderit veniam\",\n \"handle\": \"fugiat ex minim qui\",\n \"name\": \"sint ullamco\"\n },\n \"created\": \"1982-10-23T10:00:36.966Z\",\n \"dashboard_count\": 92719114,\n \"id\": -92359742,\n \"is_favorite\": true,\n \"modified\": \"1948-10-23T05:55:37.830Z\",\n \"type\": \"manual_dashboard_list\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"reprehenderit veniam\",\n \"handle\": \"fugiat ex minim qui\",\n \"name\": \"sint ullamco\"\n },\n \"created\": \"1982-10-23T10:00:36.966Z\",\n \"dashboard_count\": 92719114,\n \"id\": -92359742,\n \"is_favorite\": true,\n \"modified\": \"1948-10-23T05:55:37.830Z\",\n \"type\": \"manual_dashboard_list\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a dashboard list",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id",
"value": "-32260706"
}
]
},
"description": "Delete a dashboard list."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"deleted_dashboard_list_id\": 7398122\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual/:list_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual",
":list_id"
],
"variable": [
{
"key": "list_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Interact with your dashboard lists through the API to\norganize, find, and share all of your dashboards with your team and\norganization.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Dashboards",
"item": [
{
"name": "Create a new dashboard",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"\",\n \"layout_type\": \"ordered\",\n \"widgets\": [\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"adipisici\",\n \"title_align\": \"left\",\n \"title_size\": \"adipisicing consectetur\"\n },\n \"id\": 99861244,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": true\n }\n },\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"fugiat est eiusmod tempor\",\n \"title_align\": \"right\",\n \"title_size\": \"mollit minim\"\n },\n \"id\": -32858139,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": false\n }\n }\n ],\n \"author_handle\": \"test@datadoghq.com\",\n \"author_name\": \"John Doe\",\n \"created_at\": \"1997-08-26T04:46:53.953Z\",\n \"description\": \"minim\",\n \"id\": \"123-abc-456\",\n \"modified_at\": \"1982-02-22T10:12:31.355Z\",\n \"notify_list\": [\n \"ad sunt id\",\n \"veniam consequat\"\n ],\n \"reflow_type\": \"auto\",\n \"restricted_roles\": [\n \"sit Duis mollit sunt aute\",\n \"laboris voluptate aliqua nostrud\"\n ],\n \"tags\": [\n \"officia magna adipisicing ullamco\",\n \"consequat\"\n ],\n \"template_variable_presets\": [\n {\n \"name\": \"eu eiusmod culpa\",\n \"template_variables\": [\n {\n \"name\": \"irure nostrud tempor ad\",\n \"values\": [\n \"nostrud ea quis aute\"\n ]\n },\n {\n \"name\": \"eiusmod irure\",\n \"values\": [\n \"in laboris fugiat\"\n ]\n }\n ]\n },\n {\n \"name\": \"veniam sint dolor velit consectetur\",\n \"template_variables\": [\n {\n \"name\": \"sit et voluptate\",\n \"values\": [\n \"adipisicing commodo irure sed eu\"\n ]\n },\n {\n \"name\": \"voluptate exercitation ut est\",\n \"values\": [\n \"fugiat exercitation\"\n ]\n }\n ]\n }\n ],\n \"template_variables\": [\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n },\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n }\n ],\n \"url\": \"/dashboard/123-abc-456/example-dashboard-title\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
},
"description": "Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the `as_count()` or `as_rate()` modifiers appended.\nRefer to the following [documentation](https://docs.datadoghq.com/developers/metrics/type_modifiers/?tab=count#in-application-modifiers) for more information on these modifiers."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"\",\n \"layout_type\": \"ordered\",\n \"widgets\": [\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"adipisici\",\n \"title_align\": \"left\",\n \"title_size\": \"adipisicing consectetur\"\n },\n \"id\": 99861244,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": true\n }\n },\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"fugiat est eiusmod tempor\",\n \"title_align\": \"right\",\n \"title_size\": \"mollit minim\"\n },\n \"id\": -32858139,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": false\n }\n }\n ],\n \"author_handle\": \"test@datadoghq.com\",\n \"author_name\": \"John Doe\",\n \"created_at\": \"1997-08-26T04:46:53.953Z\",\n \"description\": \"minim\",\n \"id\": \"123-abc-456\",\n \"modified_at\": \"1982-02-22T10:12:31.355Z\",\n \"notify_list\": [\n \"ad sunt id\",\n \"veniam consequat\"\n ],\n \"reflow_type\": \"auto\",\n \"restricted_roles\": [\n \"sit Duis mollit sunt aute\",\n \"laboris voluptate aliqua nostrud\"\n ],\n \"tags\": [\n \"officia magna adipisicing ullamco\",\n \"consequat\"\n ],\n \"template_variable_presets\": [\n {\n \"name\": \"eu eiusmod culpa\",\n \"template_variables\": [\n {\n \"name\": \"irure nostrud tempor ad\",\n \"values\": [\n \"nostrud ea quis aute\"\n ]\n },\n {\n \"name\": \"eiusmod irure\",\n \"values\": [\n \"in laboris fugiat\"\n ]\n }\n ]\n },\n {\n \"name\": \"veniam sint dolor velit consectetur\",\n \"template_variables\": [\n {\n \"name\": \"sit et voluptate\",\n \"values\": [\n \"adipisicing commodo irure sed eu\"\n ]\n },\n {\n \"name\": \"voluptate exercitation ut est\",\n \"values\": [\n \"fugiat exercitation\"\n ]\n }\n ]\n }\n ],\n \"template_variables\": [\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n },\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n }\n ],\n \"url\": \"/dashboard/123-abc-456/example-dashboard-title\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"title\": \"\",\n \"layout_type\": \"ordered\",\n \"widgets\": [\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"adipisici\",\n \"title_align\": \"left\",\n \"title_size\": \"adipisicing consectetur\"\n },\n \"id\": 99861244,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": true\n }\n },\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"fugiat est eiusmod tempor\",\n \"title_align\": \"right\",\n \"title_size\": \"mollit minim\"\n },\n \"id\": -32858139,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": false\n }\n }\n ],\n \"author_handle\": \"test@datadoghq.com\",\n \"author_name\": \"John Doe\",\n \"created_at\": \"1997-08-26T04:46:53.953Z\",\n \"description\": \"minim\",\n \"id\": \"123-abc-456\",\n \"modified_at\": \"1982-02-22T10:12:31.355Z\",\n \"notify_list\": [\n \"ad sunt id\",\n \"veniam consequat\"\n ],\n \"reflow_type\": \"auto\",\n \"restricted_roles\": [\n \"sit Duis mollit sunt aute\",\n \"laboris voluptate aliqua nostrud\"\n ],\n \"tags\": [\n \"officia magna adipisicing ullamco\",\n \"consequat\"\n ],\n \"template_variable_presets\": [\n {\n \"name\": \"eu eiusmod culpa\",\n \"template_variables\": [\n {\n \"name\": \"irure nostrud tempor ad\",\n \"values\": [\n \"nostrud ea quis aute\"\n ]\n },\n {\n \"name\": \"eiusmod irure\",\n \"values\": [\n \"in laboris fugiat\"\n ]\n }\n ]\n },\n {\n \"name\": \"veniam sint dolor velit consectetur\",\n \"template_variables\": [\n {\n \"name\": \"sit et voluptate\",\n \"values\": [\n \"adipisicing commodo irure sed eu\"\n ]\n },\n {\n \"name\": \"voluptate exercitation ut est\",\n \"values\": [\n \"fugiat exercitation\"\n ]\n }\n ]\n }\n ],\n \"template_variables\": [\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n },\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n }\n ],\n \"url\": \"/dashboard/123-abc-456/example-dashboard-title\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"\",\n \"layout_type\": \"ordered\",\n \"widgets\": [\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"adipisici\",\n \"title_align\": \"left\",\n \"title_size\": \"adipisicing consectetur\"\n },\n \"id\": 99861244,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": true\n }\n },\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"fugiat est eiusmod tempor\",\n \"title_align\": \"right\",\n \"title_size\": \"mollit minim\"\n },\n \"id\": -32858139,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": false\n }\n }\n ],\n \"author_handle\": \"test@datadoghq.com\",\n \"author_name\": \"John Doe\",\n \"created_at\": \"1997-08-26T04:46:53.953Z\",\n \"description\": \"minim\",\n \"id\": \"123-abc-456\",\n \"modified_at\": \"1982-02-22T10:12:31.355Z\",\n \"notify_list\": [\n \"ad sunt id\",\n \"veniam consequat\"\n ],\n \"reflow_type\": \"auto\",\n \"restricted_roles\": [\n \"sit Duis mollit sunt aute\",\n \"laboris voluptate aliqua nostrud\"\n ],\n \"tags\": [\n \"officia magna adipisicing ullamco\",\n \"consequat\"\n ],\n \"template_variable_presets\": [\n {\n \"name\": \"eu eiusmod culpa\",\n \"template_variables\": [\n {\n \"name\": \"irure nostrud tempor ad\",\n \"values\": [\n \"nostrud ea quis aute\"\n ]\n },\n {\n \"name\": \"eiusmod irure\",\n \"values\": [\n \"in laboris fugiat\"\n ]\n }\n ]\n },\n {\n \"name\": \"veniam sint dolor velit consectetur\",\n \"template_variables\": [\n {\n \"name\": \"sit et voluptate\",\n \"values\": [\n \"adipisicing commodo irure sed eu\"\n ]\n },\n {\n \"name\": \"voluptate exercitation ut est\",\n \"values\": [\n \"fugiat exercitation\"\n ]\n }\n ]\n }\n ],\n \"template_variables\": [\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n },\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n }\n ],\n \"url\": \"/dashboard/123-abc-456/example-dashboard-title\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"\",\n \"layout_type\": \"ordered\",\n \"widgets\": [\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"adipisici\",\n \"title_align\": \"left\",\n \"title_size\": \"adipisicing consectetur\"\n },\n \"id\": 99861244,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": true\n }\n },\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"fugiat est eiusmod tempor\",\n \"title_align\": \"right\",\n \"title_size\": \"mollit minim\"\n },\n \"id\": -32858139,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": false\n }\n }\n ],\n \"author_handle\": \"test@datadoghq.com\",\n \"author_name\": \"John Doe\",\n \"created_at\": \"1997-08-26T04:46:53.953Z\",\n \"description\": \"minim\",\n \"id\": \"123-abc-456\",\n \"modified_at\": \"1982-02-22T10:12:31.355Z\",\n \"notify_list\": [\n \"ad sunt id\",\n \"veniam consequat\"\n ],\n \"reflow_type\": \"auto\",\n \"restricted_roles\": [\n \"sit Duis mollit sunt aute\",\n \"laboris voluptate aliqua nostrud\"\n ],\n \"tags\": [\n \"officia magna adipisicing ullamco\",\n \"consequat\"\n ],\n \"template_variable_presets\": [\n {\n \"name\": \"eu eiusmod culpa\",\n \"template_variables\": [\n {\n \"name\": \"irure nostrud tempor ad\",\n \"values\": [\n \"nostrud ea quis aute\"\n ]\n },\n {\n \"name\": \"eiusmod irure\",\n \"values\": [\n \"in laboris fugiat\"\n ]\n }\n ]\n },\n {\n \"name\": \"veniam sint dolor velit consectetur\",\n \"template_variables\": [\n {\n \"name\": \"sit et voluptate\",\n \"values\": [\n \"adipisicing commodo irure sed eu\"\n ]\n },\n {\n \"name\": \"voluptate exercitation ut est\",\n \"values\": [\n \"fugiat exercitation\"\n ]\n }\n ]\n }\n ],\n \"template_variables\": [\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n },\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n }\n ],\n \"url\": \"/dashboard/123-abc-456/example-dashboard-title\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"\",\n \"layout_type\": \"ordered\",\n \"widgets\": [\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"adipisici\",\n \"title_align\": \"left\",\n \"title_size\": \"adipisicing consectetur\"\n },\n \"id\": 99861244,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": true\n }\n },\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"fugiat est eiusmod tempor\",\n \"title_align\": \"right\",\n \"title_size\": \"mollit minim\"\n },\n \"id\": -32858139,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": false\n }\n }\n ],\n \"author_handle\": \"test@datadoghq.com\",\n \"author_name\": \"John Doe\",\n \"created_at\": \"1997-08-26T04:46:53.953Z\",\n \"description\": \"minim\",\n \"id\": \"123-abc-456\",\n \"modified_at\": \"1982-02-22T10:12:31.355Z\",\n \"notify_list\": [\n \"ad sunt id\",\n \"veniam consequat\"\n ],\n \"reflow_type\": \"auto\",\n \"restricted_roles\": [\n \"sit Duis mollit sunt aute\",\n \"laboris voluptate aliqua nostrud\"\n ],\n \"tags\": [\n \"officia magna adipisicing ullamco\",\n \"consequat\"\n ],\n \"template_variable_presets\": [\n {\n \"name\": \"eu eiusmod culpa\",\n \"template_variables\": [\n {\n \"name\": \"irure nostrud tempor ad\",\n \"values\": [\n \"nostrud ea quis aute\"\n ]\n },\n {\n \"name\": \"eiusmod irure\",\n \"values\": [\n \"in laboris fugiat\"\n ]\n }\n ]\n },\n {\n \"name\": \"veniam sint dolor velit consectetur\",\n \"template_variables\": [\n {\n \"name\": \"sit et voluptate\",\n \"values\": [\n \"adipisicing commodo irure sed eu\"\n ]\n },\n {\n \"name\": \"voluptate exercitation ut est\",\n \"values\": [\n \"fugiat exercitation\"\n ]\n }\n ]\n }\n ],\n \"template_variables\": [\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n },\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n }\n ],\n \"url\": \"/dashboard/123-abc-456/example-dashboard-title\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a dashboard",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id",
"value": "dolor veniam nostrud cillum"
}
]
},
"description": "Get a dashboard using the specified ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"title\": \"\",\n \"layout_type\": \"ordered\",\n \"widgets\": [\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"adipisici\",\n \"title_align\": \"left\",\n \"title_size\": \"adipisicing consectetur\"\n },\n \"id\": 99861244,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": true\n }\n },\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"fugiat est eiusmod tempor\",\n \"title_align\": \"right\",\n \"title_size\": \"mollit minim\"\n },\n \"id\": -32858139,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": false\n }\n }\n ],\n \"author_handle\": \"test@datadoghq.com\",\n \"author_name\": \"John Doe\",\n \"created_at\": \"1997-08-26T04:46:53.953Z\",\n \"description\": \"minim\",\n \"id\": \"123-abc-456\",\n \"modified_at\": \"1982-02-22T10:12:31.355Z\",\n \"notify_list\": [\n \"ad sunt id\",\n \"veniam consequat\"\n ],\n \"reflow_type\": \"auto\",\n \"restricted_roles\": [\n \"sit Duis mollit sunt aute\",\n \"laboris voluptate aliqua nostrud\"\n ],\n \"tags\": [\n \"officia magna adipisicing ullamco\",\n \"consequat\"\n ],\n \"template_variable_presets\": [\n {\n \"name\": \"eu eiusmod culpa\",\n \"template_variables\": [\n {\n \"name\": \"irure nostrud tempor ad\",\n \"values\": [\n \"nostrud ea quis aute\"\n ]\n },\n {\n \"name\": \"eiusmod irure\",\n \"values\": [\n \"in laboris fugiat\"\n ]\n }\n ]\n },\n {\n \"name\": \"veniam sint dolor velit consectetur\",\n \"template_variables\": [\n {\n \"name\": \"sit et voluptate\",\n \"values\": [\n \"adipisicing commodo irure sed eu\"\n ]\n },\n {\n \"name\": \"voluptate exercitation ut est\",\n \"values\": [\n \"fugiat exercitation\"\n ]\n }\n ]\n }\n ],\n \"template_variables\": [\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n },\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n }\n ],\n \"url\": \"/dashboard/123-abc-456/example-dashboard-title\"\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all dashboards",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard?filter[shared]=false&filter[deleted]=true&count=100&start=-86876392",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
],
"query": [
{
"key": "filter[shared]",
"value": "false",
"description": "When `true`, this query only returns shared custom created\nor cloned dashboards."
},
{
"key": "filter[deleted]",
"value": "true",
"description": "When `true`, this query returns only deleted custom-created\nor cloned dashboards. This parameter is incompatible with `filter[shared]`."
},
{
"key": "count",
"value": "100",
"description": "The maximum number of dashboards returned in the list."
},
{
"key": "start",
"value": "-86876392",
"description": "The specific offset to use as the beginning of the returned response."
}
]
},
"description": "Get all dashboards.\n\n**Note**: This query will only return custom created or cloned dashboards.\nThis query will not return preset dashboards."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard?filter[shared]=false&filter[deleted]=true&count=100&start=-86876392",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
],
"query": [
{
"key": "filter[shared]",
"value": "false",
"description": "When `true`, this query only returns shared custom created\nor cloned dashboards."
},
{
"key": "filter[deleted]",
"value": "true",
"description": "When `true`, this query returns only deleted custom-created\nor cloned dashboards. This parameter is incompatible with `filter[shared]`."
},
{
"key": "count",
"value": "100",
"description": "The maximum number of dashboards returned in the list."
},
{
"key": "start",
"value": "-86876392",
"description": "The specific offset to use as the beginning of the returned response."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"dashboards\": [\n {\n \"author_handle\": \"r\",\n \"created_at\": \"2009-09-08T08:20:37.849Z\",\n \"description\": \"pariatur\",\n \"id\": \"aute esse\",\n \"layout_type\": \"ordered\",\n \"modified_at\": \"2001-07-28T15:26:16.792Z\",\n \"title\": \"dolore fugiat labore tempor \",\n \"url\": \"quis do dolor deserunt\"\n },\n {\n \"author_handle\": \"do\",\n \"created_at\": \"2020-12-08T01:28:19.591Z\",\n \"description\": \"velit ad\",\n \"id\": \"non aliquip irure\",\n \"layout_type\": \"ordered\",\n \"modified_at\": \"1984-09-08T03:11:15.617Z\",\n \"title\": \"Excepteur\",\n \"url\": \"officia nisi in laborum Lorem\"\n }\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard?filter[shared]=false&filter[deleted]=true&count=100&start=-86876392",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
],
"query": [
{
"key": "filter[shared]",
"value": "false",
"description": "When `true`, this query only returns shared custom created\nor cloned dashboards."
},
{
"key": "filter[deleted]",
"value": "true",
"description": "When `true`, this query returns only deleted custom-created\nor cloned dashboards. This parameter is incompatible with `filter[shared]`."
},
{
"key": "count",
"value": "100",
"description": "The maximum number of dashboards returned in the list."
},
{
"key": "start",
"value": "-86876392",
"description": "The specific offset to use as the beginning of the returned response."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard?filter[shared]=false&filter[deleted]=true&count=100&start=-86876392",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
],
"query": [
{
"key": "filter[shared]",
"value": "false",
"description": "When `true`, this query only returns shared custom created\nor cloned dashboards."
},
{
"key": "filter[deleted]",
"value": "true",
"description": "When `true`, this query returns only deleted custom-created\nor cloned dashboards. This parameter is incompatible with `filter[shared]`."
},
{
"key": "count",
"value": "100",
"description": "The maximum number of dashboards returned in the list."
},
{
"key": "start",
"value": "-86876392",
"description": "The specific offset to use as the beginning of the returned response."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a dashboard",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"\",\n \"layout_type\": \"ordered\",\n \"widgets\": [\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"adipisici\",\n \"title_align\": \"left\",\n \"title_size\": \"adipisicing consectetur\"\n },\n \"id\": 99861244,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": true\n }\n },\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"fugiat est eiusmod tempor\",\n \"title_align\": \"right\",\n \"title_size\": \"mollit minim\"\n },\n \"id\": -32858139,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": false\n }\n }\n ],\n \"author_handle\": \"test@datadoghq.com\",\n \"author_name\": \"John Doe\",\n \"created_at\": \"1997-08-26T04:46:53.953Z\",\n \"description\": \"minim\",\n \"id\": \"123-abc-456\",\n \"modified_at\": \"1982-02-22T10:12:31.355Z\",\n \"notify_list\": [\n \"ad sunt id\",\n \"veniam consequat\"\n ],\n \"reflow_type\": \"auto\",\n \"restricted_roles\": [\n \"sit Duis mollit sunt aute\",\n \"laboris voluptate aliqua nostrud\"\n ],\n \"tags\": [\n \"officia magna adipisicing ullamco\",\n \"consequat\"\n ],\n \"template_variable_presets\": [\n {\n \"name\": \"eu eiusmod culpa\",\n \"template_variables\": [\n {\n \"name\": \"irure nostrud tempor ad\",\n \"values\": [\n \"nostrud ea quis aute\"\n ]\n },\n {\n \"name\": \"eiusmod irure\",\n \"values\": [\n \"in laboris fugiat\"\n ]\n }\n ]\n },\n {\n \"name\": \"veniam sint dolor velit consectetur\",\n \"template_variables\": [\n {\n \"name\": \"sit et voluptate\",\n \"values\": [\n \"adipisicing commodo irure sed eu\"\n ]\n },\n {\n \"name\": \"voluptate exercitation ut est\",\n \"values\": [\n \"fugiat exercitation\"\n ]\n }\n ]\n }\n ],\n \"template_variables\": [\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n },\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n }\n ],\n \"url\": \"/dashboard/123-abc-456/example-dashboard-title\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id",
"value": "dolor veniam nostrud cillum"
}
]
},
"description": "Update a dashboard using the specified ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"\",\n \"layout_type\": \"ordered\",\n \"widgets\": [\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"adipisici\",\n \"title_align\": \"left\",\n \"title_size\": \"adipisicing consectetur\"\n },\n \"id\": 99861244,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": true\n }\n },\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"fugiat est eiusmod tempor\",\n \"title_align\": \"right\",\n \"title_size\": \"mollit minim\"\n },\n \"id\": -32858139,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": false\n }\n }\n ],\n \"author_handle\": \"test@datadoghq.com\",\n \"author_name\": \"John Doe\",\n \"created_at\": \"1997-08-26T04:46:53.953Z\",\n \"description\": \"minim\",\n \"id\": \"123-abc-456\",\n \"modified_at\": \"1982-02-22T10:12:31.355Z\",\n \"notify_list\": [\n \"ad sunt id\",\n \"veniam consequat\"\n ],\n \"reflow_type\": \"auto\",\n \"restricted_roles\": [\n \"sit Duis mollit sunt aute\",\n \"laboris voluptate aliqua nostrud\"\n ],\n \"tags\": [\n \"officia magna adipisicing ullamco\",\n \"consequat\"\n ],\n \"template_variable_presets\": [\n {\n \"name\": \"eu eiusmod culpa\",\n \"template_variables\": [\n {\n \"name\": \"irure nostrud tempor ad\",\n \"values\": [\n \"nostrud ea quis aute\"\n ]\n },\n {\n \"name\": \"eiusmod irure\",\n \"values\": [\n \"in laboris fugiat\"\n ]\n }\n ]\n },\n {\n \"name\": \"veniam sint dolor velit consectetur\",\n \"template_variables\": [\n {\n \"name\": \"sit et voluptate\",\n \"values\": [\n \"adipisicing commodo irure sed eu\"\n ]\n },\n {\n \"name\": \"voluptate exercitation ut est\",\n \"values\": [\n \"fugiat exercitation\"\n ]\n }\n ]\n }\n ],\n \"template_variables\": [\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n },\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n }\n ],\n \"url\": \"/dashboard/123-abc-456/example-dashboard-title\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"title\": \"\",\n \"layout_type\": \"ordered\",\n \"widgets\": [\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"adipisici\",\n \"title_align\": \"left\",\n \"title_size\": \"adipisicing consectetur\"\n },\n \"id\": 99861244,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": true\n }\n },\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"fugiat est eiusmod tempor\",\n \"title_align\": \"right\",\n \"title_size\": \"mollit minim\"\n },\n \"id\": -32858139,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": false\n }\n }\n ],\n \"author_handle\": \"test@datadoghq.com\",\n \"author_name\": \"John Doe\",\n \"created_at\": \"1997-08-26T04:46:53.953Z\",\n \"description\": \"minim\",\n \"id\": \"123-abc-456\",\n \"modified_at\": \"1982-02-22T10:12:31.355Z\",\n \"notify_list\": [\n \"ad sunt id\",\n \"veniam consequat\"\n ],\n \"reflow_type\": \"auto\",\n \"restricted_roles\": [\n \"sit Duis mollit sunt aute\",\n \"laboris voluptate aliqua nostrud\"\n ],\n \"tags\": [\n \"officia magna adipisicing ullamco\",\n \"consequat\"\n ],\n \"template_variable_presets\": [\n {\n \"name\": \"eu eiusmod culpa\",\n \"template_variables\": [\n {\n \"name\": \"irure nostrud tempor ad\",\n \"values\": [\n \"nostrud ea quis aute\"\n ]\n },\n {\n \"name\": \"eiusmod irure\",\n \"values\": [\n \"in laboris fugiat\"\n ]\n }\n ]\n },\n {\n \"name\": \"veniam sint dolor velit consectetur\",\n \"template_variables\": [\n {\n \"name\": \"sit et voluptate\",\n \"values\": [\n \"adipisicing commodo irure sed eu\"\n ]\n },\n {\n \"name\": \"voluptate exercitation ut est\",\n \"values\": [\n \"fugiat exercitation\"\n ]\n }\n ]\n }\n ],\n \"template_variables\": [\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n },\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n }\n ],\n \"url\": \"/dashboard/123-abc-456/example-dashboard-title\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"\",\n \"layout_type\": \"ordered\",\n \"widgets\": [\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"adipisici\",\n \"title_align\": \"left\",\n \"title_size\": \"adipisicing consectetur\"\n },\n \"id\": 99861244,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": true\n }\n },\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"fugiat est eiusmod tempor\",\n \"title_align\": \"right\",\n \"title_size\": \"mollit minim\"\n },\n \"id\": -32858139,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": false\n }\n }\n ],\n \"author_handle\": \"test@datadoghq.com\",\n \"author_name\": \"John Doe\",\n \"created_at\": \"1997-08-26T04:46:53.953Z\",\n \"description\": \"minim\",\n \"id\": \"123-abc-456\",\n \"modified_at\": \"1982-02-22T10:12:31.355Z\",\n \"notify_list\": [\n \"ad sunt id\",\n \"veniam consequat\"\n ],\n \"reflow_type\": \"auto\",\n \"restricted_roles\": [\n \"sit Duis mollit sunt aute\",\n \"laboris voluptate aliqua nostrud\"\n ],\n \"tags\": [\n \"officia magna adipisicing ullamco\",\n \"consequat\"\n ],\n \"template_variable_presets\": [\n {\n \"name\": \"eu eiusmod culpa\",\n \"template_variables\": [\n {\n \"name\": \"irure nostrud tempor ad\",\n \"values\": [\n \"nostrud ea quis aute\"\n ]\n },\n {\n \"name\": \"eiusmod irure\",\n \"values\": [\n \"in laboris fugiat\"\n ]\n }\n ]\n },\n {\n \"name\": \"veniam sint dolor velit consectetur\",\n \"template_variables\": [\n {\n \"name\": \"sit et voluptate\",\n \"values\": [\n \"adipisicing commodo irure sed eu\"\n ]\n },\n {\n \"name\": \"voluptate exercitation ut est\",\n \"values\": [\n \"fugiat exercitation\"\n ]\n }\n ]\n }\n ],\n \"template_variables\": [\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n },\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n }\n ],\n \"url\": \"/dashboard/123-abc-456/example-dashboard-title\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"\",\n \"layout_type\": \"ordered\",\n \"widgets\": [\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"adipisici\",\n \"title_align\": \"left\",\n \"title_size\": \"adipisicing consectetur\"\n },\n \"id\": 99861244,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": true\n }\n },\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"fugiat est eiusmod tempor\",\n \"title_align\": \"right\",\n \"title_size\": \"mollit minim\"\n },\n \"id\": -32858139,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": false\n }\n }\n ],\n \"author_handle\": \"test@datadoghq.com\",\n \"author_name\": \"John Doe\",\n \"created_at\": \"1997-08-26T04:46:53.953Z\",\n \"description\": \"minim\",\n \"id\": \"123-abc-456\",\n \"modified_at\": \"1982-02-22T10:12:31.355Z\",\n \"notify_list\": [\n \"ad sunt id\",\n \"veniam consequat\"\n ],\n \"reflow_type\": \"auto\",\n \"restricted_roles\": [\n \"sit Duis mollit sunt aute\",\n \"laboris voluptate aliqua nostrud\"\n ],\n \"tags\": [\n \"officia magna adipisicing ullamco\",\n \"consequat\"\n ],\n \"template_variable_presets\": [\n {\n \"name\": \"eu eiusmod culpa\",\n \"template_variables\": [\n {\n \"name\": \"irure nostrud tempor ad\",\n \"values\": [\n \"nostrud ea quis aute\"\n ]\n },\n {\n \"name\": \"eiusmod irure\",\n \"values\": [\n \"in laboris fugiat\"\n ]\n }\n ]\n },\n {\n \"name\": \"veniam sint dolor velit consectetur\",\n \"template_variables\": [\n {\n \"name\": \"sit et voluptate\",\n \"values\": [\n \"adipisicing commodo irure sed eu\"\n ]\n },\n {\n \"name\": \"voluptate exercitation ut est\",\n \"values\": [\n \"fugiat exercitation\"\n ]\n }\n ]\n }\n ],\n \"template_variables\": [\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n },\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n }\n ],\n \"url\": \"/dashboard/123-abc-456/example-dashboard-title\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"\",\n \"layout_type\": \"ordered\",\n \"widgets\": [\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"adipisici\",\n \"title_align\": \"left\",\n \"title_size\": \"adipisicing consectetur\"\n },\n \"id\": 99861244,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": true\n }\n },\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"fugiat est eiusmod tempor\",\n \"title_align\": \"right\",\n \"title_size\": \"mollit minim\"\n },\n \"id\": -32858139,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": false\n }\n }\n ],\n \"author_handle\": \"test@datadoghq.com\",\n \"author_name\": \"John Doe\",\n \"created_at\": \"1997-08-26T04:46:53.953Z\",\n \"description\": \"minim\",\n \"id\": \"123-abc-456\",\n \"modified_at\": \"1982-02-22T10:12:31.355Z\",\n \"notify_list\": [\n \"ad sunt id\",\n \"veniam consequat\"\n ],\n \"reflow_type\": \"auto\",\n \"restricted_roles\": [\n \"sit Duis mollit sunt aute\",\n \"laboris voluptate aliqua nostrud\"\n ],\n \"tags\": [\n \"officia magna adipisicing ullamco\",\n \"consequat\"\n ],\n \"template_variable_presets\": [\n {\n \"name\": \"eu eiusmod culpa\",\n \"template_variables\": [\n {\n \"name\": \"irure nostrud tempor ad\",\n \"values\": [\n \"nostrud ea quis aute\"\n ]\n },\n {\n \"name\": \"eiusmod irure\",\n \"values\": [\n \"in laboris fugiat\"\n ]\n }\n ]\n },\n {\n \"name\": \"veniam sint dolor velit consectetur\",\n \"template_variables\": [\n {\n \"name\": \"sit et voluptate\",\n \"values\": [\n \"adipisicing commodo irure sed eu\"\n ]\n },\n {\n \"name\": \"voluptate exercitation ut est\",\n \"values\": [\n \"fugiat exercitation\"\n ]\n }\n ]\n }\n ],\n \"template_variables\": [\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n },\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n }\n ],\n \"url\": \"/dashboard/123-abc-456/example-dashboard-title\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"\",\n \"layout_type\": \"ordered\",\n \"widgets\": [\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"adipisici\",\n \"title_align\": \"left\",\n \"title_size\": \"adipisicing consectetur\"\n },\n \"id\": 99861244,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": true\n }\n },\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"fugiat est eiusmod tempor\",\n \"title_align\": \"right\",\n \"title_size\": \"mollit minim\"\n },\n \"id\": -32858139,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": false\n }\n }\n ],\n \"author_handle\": \"test@datadoghq.com\",\n \"author_name\": \"John Doe\",\n \"created_at\": \"1997-08-26T04:46:53.953Z\",\n \"description\": \"minim\",\n \"id\": \"123-abc-456\",\n \"modified_at\": \"1982-02-22T10:12:31.355Z\",\n \"notify_list\": [\n \"ad sunt id\",\n \"veniam consequat\"\n ],\n \"reflow_type\": \"auto\",\n \"restricted_roles\": [\n \"sit Duis mollit sunt aute\",\n \"laboris voluptate aliqua nostrud\"\n ],\n \"tags\": [\n \"officia magna adipisicing ullamco\",\n \"consequat\"\n ],\n \"template_variable_presets\": [\n {\n \"name\": \"eu eiusmod culpa\",\n \"template_variables\": [\n {\n \"name\": \"irure nostrud tempor ad\",\n \"values\": [\n \"nostrud ea quis aute\"\n ]\n },\n {\n \"name\": \"eiusmod irure\",\n \"values\": [\n \"in laboris fugiat\"\n ]\n }\n ]\n },\n {\n \"name\": \"veniam sint dolor velit consectetur\",\n \"template_variables\": [\n {\n \"name\": \"sit et voluptate\",\n \"values\": [\n \"adipisicing commodo irure sed eu\"\n ]\n },\n {\n \"name\": \"voluptate exercitation ut est\",\n \"values\": [\n \"fugiat exercitation\"\n ]\n }\n ]\n }\n ],\n \"template_variables\": [\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n },\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n }\n ],\n \"url\": \"/dashboard/123-abc-456/example-dashboard-title\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a dashboard",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id",
"value": "dolor veniam nostrud cillum"
}
]
},
"description": "Delete a dashboard using the specified ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"deleted_dashboard_id\": \"Lorem adipisicing eu\"\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Dashboards Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete dashboards",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"123-abc-456\",\n \"type\": \"dashboard\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
},
"description": "Delete dashboards using the specified IDs. If there are any failures, no dashboards will be deleted (partial success is not allowed)."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"123-abc-456\",\n \"type\": \"dashboard\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"123-abc-456\",\n \"type\": \"dashboard\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"123-abc-456\",\n \"type\": \"dashboard\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Dashboards Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"123-abc-456\",\n \"type\": \"dashboard\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"123-abc-456\",\n \"type\": \"dashboard\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Restore deleted dashboards",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"123-abc-456\",\n \"type\": \"dashboard\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
},
"description": "Restore dashboards using the specified IDs. If there are any failures, no dashboards will be restored (partial success is not allowed)."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"123-abc-456\",\n \"type\": \"dashboard\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"123-abc-456\",\n \"type\": \"dashboard\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"123-abc-456\",\n \"type\": \"dashboard\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Dashboards Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"123-abc-456\",\n \"type\": \"dashboard\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"123-abc-456\",\n \"type\": \"dashboard\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a shared dashboard",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboard_id\": \"123-abc-456\",\n \"dashboard_type\": \"custom_timeboard\",\n \"share_type\": \"open\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public"
]
},
"description": "Share a specified private dashboard, generating a URL at which it can be publicly viewed."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboard_id\": \"123-abc-456\",\n \"dashboard_type\": \"custom_timeboard\",\n \"share_type\": \"open\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"dashboard_id\": \"123-abc-456\",\n \"dashboard_type\": \"custom_timeboard\",\n \"author\": {\n \"handle\": \"test@datadoghq.com\",\n \"name\": \"dolore Ut\"\n },\n \"created\": \"1977-07-20T13:06:57.868Z\",\n \"embeddable_domains\": [\n \"https://domain.atlassian.net/\",\n \"http://myserver.com/\"\n ],\n \"expiration\": \"1945-12-04T11:46:19.558Z\",\n \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"global_time_selectable_enabled\": false,\n \"invitees\": [\n {\n \"access_expiration\": \"2030-01-01T12:00:00.00Z\",\n \"email\": \"test@datadoghq.com\"\n },\n {\n \"access_expiration\": null,\n \"email\": \"test2@datadoghq.com\"\n }\n ],\n \"last_accessed\": \"1962-03-25T22:26:37.020Z\",\n \"public_url\": \"id do\",\n \"selectable_template_vars\": [\n {\n \"default_value\": \"*\",\n \"name\": \"exampleVar\",\n \"prefix\": \"test\",\n \"visible_tags\": [\n \"selectableValue1\",\n \"selectableValue2\"\n ]\n }\n ],\n \"share_type\": \"open\",\n \"status\": \"active\",\n \"title\": \"et ea minim\",\n \"token\": \"reprehenderit\",\n \"viewing_preferences\": {\n \"high_density\": true,\n \"theme\": \"light\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboard_id\": \"123-abc-456\",\n \"dashboard_type\": \"custom_timeboard\",\n \"share_type\": \"open\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboard_id\": \"123-abc-456\",\n \"dashboard_type\": \"custom_timeboard\",\n \"share_type\": \"open\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Dashboard Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboard_id\": \"123-abc-456\",\n \"dashboard_type\": \"custom_timeboard\",\n \"share_type\": \"open\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboard_id\": \"123-abc-456\",\n \"dashboard_type\": \"custom_timeboard\",\n \"share_type\": \"open\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a shared dashboard",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token",
"value": "dolor veniam nostrud cillum"
}
]
},
"description": "Fetch an existing shared dashboard's sharing metadata associated with the specified token."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"dashboard_id\": \"123-abc-456\",\n \"dashboard_type\": \"custom_timeboard\",\n \"author\": {\n \"handle\": \"test@datadoghq.com\",\n \"name\": \"dolore Ut\"\n },\n \"created\": \"1977-07-20T13:06:57.868Z\",\n \"embeddable_domains\": [\n \"https://domain.atlassian.net/\",\n \"http://myserver.com/\"\n ],\n \"expiration\": \"1945-12-04T11:46:19.558Z\",\n \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"global_time_selectable_enabled\": false,\n \"invitees\": [\n {\n \"access_expiration\": \"2030-01-01T12:00:00.00Z\",\n \"email\": \"test@datadoghq.com\"\n },\n {\n \"access_expiration\": null,\n \"email\": \"test2@datadoghq.com\"\n }\n ],\n \"last_accessed\": \"1962-03-25T22:26:37.020Z\",\n \"public_url\": \"id do\",\n \"selectable_template_vars\": [\n {\n \"default_value\": \"*\",\n \"name\": \"exampleVar\",\n \"prefix\": \"test\",\n \"visible_tags\": [\n \"selectableValue1\",\n \"selectableValue2\"\n ]\n }\n ],\n \"share_type\": \"open\",\n \"status\": \"active\",\n \"title\": \"et ea minim\",\n \"token\": \"reprehenderit\",\n \"viewing_preferences\": {\n \"high_density\": true,\n \"theme\": \"light\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Shared Dashboard Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a shared dashboard",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"share_list\": [\n \"test@datadoghq.com\",\n \"test2@datadoghq.com\"\n ],\n \"share_type\": \"invite\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token",
"value": "dolor veniam nostrud cillum"
}
]
},
"description": "Update a shared dashboard associated with the specified token."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"share_list\": [\n \"test@datadoghq.com\",\n \"test2@datadoghq.com\"\n ],\n \"share_type\": \"invite\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"dashboard_id\": \"123-abc-456\",\n \"dashboard_type\": \"custom_timeboard\",\n \"author\": {\n \"handle\": \"test@datadoghq.com\",\n \"name\": \"dolore Ut\"\n },\n \"created\": \"1977-07-20T13:06:57.868Z\",\n \"embeddable_domains\": [\n \"https://domain.atlassian.net/\",\n \"http://myserver.com/\"\n ],\n \"expiration\": \"1945-12-04T11:46:19.558Z\",\n \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"global_time_selectable_enabled\": false,\n \"invitees\": [\n {\n \"access_expiration\": \"2030-01-01T12:00:00.00Z\",\n \"email\": \"test@datadoghq.com\"\n },\n {\n \"access_expiration\": null,\n \"email\": \"test2@datadoghq.com\"\n }\n ],\n \"last_accessed\": \"1962-03-25T22:26:37.020Z\",\n \"public_url\": \"id do\",\n \"selectable_template_vars\": [\n {\n \"default_value\": \"*\",\n \"name\": \"exampleVar\",\n \"prefix\": \"test\",\n \"visible_tags\": [\n \"selectableValue1\",\n \"selectableValue2\"\n ]\n }\n ],\n \"share_type\": \"open\",\n \"status\": \"active\",\n \"title\": \"et ea minim\",\n \"token\": \"reprehenderit\",\n \"viewing_preferences\": {\n \"high_density\": true,\n \"theme\": \"light\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"share_list\": [\n \"test@datadoghq.com\",\n \"test2@datadoghq.com\"\n ],\n \"share_type\": \"invite\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"share_list\": [\n \"test@datadoghq.com\",\n \"test2@datadoghq.com\"\n ],\n \"share_type\": \"invite\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"share_list\": [\n \"test@datadoghq.com\",\n \"test2@datadoghq.com\"\n ],\n \"share_type\": \"invite\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"share_list\": [\n \"test@datadoghq.com\",\n \"test2@datadoghq.com\"\n ],\n \"share_type\": \"invite\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Send shared dashboard invitation email",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token",
"value": "dolor veniam nostrud cillum"
}
]
},
"description": "Send emails to specified email addresses containing links to access a given authenticated shared dashboard. Email addresses must already belong to the authenticated shared dashboard's share_list."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all invitations for a shared dashboard",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation?page_size=-86876392&page_number=-86876392",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"query": [
{
"key": "page_size",
"value": "-86876392",
"description": "The number of records to return in a single request."
},
{
"key": "page_number",
"value": "-86876392",
"description": "The page to access (base 0)."
}
],
"variable": [
{
"key": "token",
"value": "dolor veniam nostrud cillum"
}
]
},
"description": "Describe the invitations that exist for the given shared dashboard (paginated)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation?page_size=-86876392&page_number=-86876392",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"query": [
{
"key": "page_size",
"value": "-86876392",
"description": "The number of records to return in a single request."
},
{
"key": "page_number",
"value": "-86876392",
"description": "The page to access (base 0)."
}
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation?page_size=-86876392&page_number=-86876392",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"query": [
{
"key": "page_size",
"value": "-86876392",
"description": "The number of records to return in a single request."
},
{
"key": "page_number",
"value": "-86876392",
"description": "The page to access (base 0)."
}
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation?page_size=-86876392&page_number=-86876392",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"query": [
{
"key": "page_size",
"value": "-86876392",
"description": "The number of records to return in a single request."
},
{
"key": "page_number",
"value": "-86876392",
"description": "The page to access (base 0)."
}
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation?page_size=-86876392&page_number=-86876392",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"query": [
{
"key": "page_size",
"value": "-86876392",
"description": "The number of records to return in a single request."
},
{
"key": "page_number",
"value": "-86876392",
"description": "The page to access (base 0)."
}
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Revoke a shared dashboard URL",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token",
"value": "dolor veniam nostrud cillum"
}
]
},
"description": "Revoke the public URL for a dashboard (rendering it private) associated with the specified token."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"deleted_public_dashboard_token\": \"nulla labore\"\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Shared Dashboard Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Revoke shared dashboard invitations",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token",
"value": "dolor veniam nostrud cillum"
}
]
},
"description": "Revoke previously sent invitation emails and active sessions used to access a given shared dashboard for specific email addresses."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Manage all your dashboards, as well as access to your shared dashboards, through the API. See the [Dashboards page](https://docs.datadoghq.com/dashboards/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Domain Allowlist",
"item": [
{
"name": "Get Domain Allowlist",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/domain_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"domain_allowlist"
]
},
"description": "Get the domain allowlist for an organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/domain_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"domain_allowlist"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"domain_allowlist\",\n \"attributes\": {\n \"domains\": [\n \"Lorem ut\",\n \"laborum sit commodo sint\"\n ],\n \"enabled\": true\n },\n \"id\": \"voluptate eu est\"\n }\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/domain_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"domain_allowlist"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Sets Domain Allowlist",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"domain_allowlist\",\n \"attributes\": {\n \"domains\": [\n \"et in\",\n \"eu exercitation nulla \"\n ],\n \"enabled\": true\n },\n \"id\": \"minim ad aliqua ut\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/domain_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"domain_allowlist"
]
},
"description": "Update the domain allowlist for an organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"domain_allowlist\",\n \"attributes\": {\n \"domains\": [\n \"et in\",\n \"eu exercitation nulla \"\n ],\n \"enabled\": true\n },\n \"id\": \"minim ad aliqua ut\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/domain_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"domain_allowlist"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"domain_allowlist\",\n \"attributes\": {\n \"domains\": [\n \"Lorem ut\",\n \"laborum sit commodo sint\"\n ],\n \"enabled\": true\n },\n \"id\": \"voluptate eu est\"\n }\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"domain_allowlist\",\n \"attributes\": {\n \"domains\": [\n \"et in\",\n \"eu exercitation nulla \"\n ],\n \"enabled\": true\n },\n \"id\": \"minim ad aliqua ut\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/domain_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"domain_allowlist"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Configure your Datadog Email Domain Allowlist directly through the Datadog API.\nThe Email Domain Allowlist controls the domains that certain datadog emails can be sent to.\nFor more information, see the [Domain Allowlist docs page](https://docs.datadoghq.com/account_management/org_settings/domain_allowlist)",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "DORA Metrics",
"item": [
{
"name": "Send a deployment event for DORA Metrics",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"service\": \"shopist\",\n \"started_at\": 1693491974000000000,\n \"finished_at\": 1693491984000000000,\n \"custom_tags\": [\n \"language:java\",\n \"department:engineering\"\n ],\n \"env\": \"staging\",\n \"git\": {\n \"repository_url\": \"https://github.com/organization/example-repository\",\n \"commit_sha\": \"66adc9350f2cc9b250b69abddab733dd55e1a588\"\n },\n \"id\": \"ad voluptate\",\n \"team\": \"backend\",\n \"version\": \"v1.12.07\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployment"
]
},
"description": "Use this API endpoint to provide data about deployments for DORA metrics.\n\nThis is necessary for:\n- Deployment Frequency\n- Change Lead Time\n- Change Failure Rate"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"service\": \"shopist\",\n \"started_at\": 1693491974000000000,\n \"finished_at\": 1693491984000000000,\n \"custom_tags\": [\n \"language:java\",\n \"department:engineering\"\n ],\n \"env\": \"staging\",\n \"git\": {\n \"repository_url\": \"https://github.com/organization/example-repository\",\n \"commit_sha\": \"66adc9350f2cc9b250b69abddab733dd55e1a588\"\n },\n \"id\": \"ad voluptate\",\n \"team\": \"backend\",\n \"version\": \"v1.12.07\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployment"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"4242fcdd31586083\",\n \"type\": \"dora_deployment\"\n }\n}"
},
{
"name": "OK - but delayed due to incident",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"service\": \"shopist\",\n \"started_at\": 1693491974000000000,\n \"finished_at\": 1693491984000000000,\n \"custom_tags\": [\n \"language:java\",\n \"department:engineering\"\n ],\n \"env\": \"staging\",\n \"git\": {\n \"repository_url\": \"https://github.com/organization/example-repository\",\n \"commit_sha\": \"66adc9350f2cc9b250b69abddab733dd55e1a588\"\n },\n \"id\": \"ad voluptate\",\n \"team\": \"backend\",\n \"version\": \"v1.12.07\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployment"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"4242fcdd31586083\",\n \"type\": \"dora_deployment\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"service\": \"shopist\",\n \"started_at\": 1693491974000000000,\n \"finished_at\": 1693491984000000000,\n \"custom_tags\": [\n \"language:java\",\n \"department:engineering\"\n ],\n \"env\": \"staging\",\n \"git\": {\n \"repository_url\": \"https://github.com/organization/example-repository\",\n \"commit_sha\": \"66adc9350f2cc9b250b69abddab733dd55e1a588\"\n },\n \"id\": \"ad voluptate\",\n \"team\": \"backend\",\n \"version\": \"v1.12.07\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployment"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sit_2\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"non_a\": {},\n \"in_1\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"service\": \"shopist\",\n \"started_at\": 1693491974000000000,\n \"finished_at\": 1693491984000000000,\n \"custom_tags\": [\n \"language:java\",\n \"department:engineering\"\n ],\n \"env\": \"staging\",\n \"git\": {\n \"repository_url\": \"https://github.com/organization/example-repository\",\n \"commit_sha\": \"66adc9350f2cc9b250b69abddab733dd55e1a588\"\n },\n \"id\": \"ad voluptate\",\n \"team\": \"backend\",\n \"version\": \"v1.12.07\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployment"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"service\": \"shopist\",\n \"started_at\": 1693491974000000000,\n \"finished_at\": 1693491984000000000,\n \"custom_tags\": [\n \"language:java\",\n \"department:engineering\"\n ],\n \"env\": \"staging\",\n \"git\": {\n \"repository_url\": \"https://github.com/organization/example-repository\",\n \"commit_sha\": \"66adc9350f2cc9b250b69abddab733dd55e1a588\"\n },\n \"id\": \"ad voluptate\",\n \"team\": \"backend\",\n \"version\": \"v1.12.07\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployment",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployment"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Send a failure event for DORA Metrics",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"started_at\": 1693491974000000000,\n \"custom_tags\": [\n \"language:java\",\n \"department:engineering\"\n ],\n \"env\": \"staging\",\n \"finished_at\": 1693491984000000000,\n \"git\": {\n \"repository_url\": \"https://github.com/organization/example-repository\",\n \"commit_sha\": \"66adc9350f2cc9b250b69abddab733dd55e1a588\"\n },\n \"id\": \"est non\",\n \"name\": \"Webserver is down failing all requests.\",\n \"services\": [\n \"shopist\"\n ],\n \"severity\": \"High\",\n \"team\": \"backend\",\n \"version\": \"v1.12.07\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failure"
]
},
"description": "Use this API endpoint to provide failure data for DORA metrics.\n\nThis is necessary for:\n- Change Failure Rate\n- Time to Restore"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"started_at\": 1693491974000000000,\n \"custom_tags\": [\n \"language:java\",\n \"department:engineering\"\n ],\n \"env\": \"staging\",\n \"finished_at\": 1693491984000000000,\n \"git\": {\n \"repository_url\": \"https://github.com/organization/example-repository\",\n \"commit_sha\": \"66adc9350f2cc9b250b69abddab733dd55e1a588\"\n },\n \"id\": \"est non\",\n \"name\": \"Webserver is down failing all requests.\",\n \"services\": [\n \"shopist\"\n ],\n \"severity\": \"High\",\n \"team\": \"backend\",\n \"version\": \"v1.12.07\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failure"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"4242fcdd31586083\",\n \"type\": \"dora_failure\"\n }\n}"
},
{
"name": "OK - but delayed due to incident",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"started_at\": 1693491974000000000,\n \"custom_tags\": [\n \"language:java\",\n \"department:engineering\"\n ],\n \"env\": \"staging\",\n \"finished_at\": 1693491984000000000,\n \"git\": {\n \"repository_url\": \"https://github.com/organization/example-repository\",\n \"commit_sha\": \"66adc9350f2cc9b250b69abddab733dd55e1a588\"\n },\n \"id\": \"est non\",\n \"name\": \"Webserver is down failing all requests.\",\n \"services\": [\n \"shopist\"\n ],\n \"severity\": \"High\",\n \"team\": \"backend\",\n \"version\": \"v1.12.07\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failure"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"4242fcdd31586083\",\n \"type\": \"dora_failure\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"started_at\": 1693491974000000000,\n \"custom_tags\": [\n \"language:java\",\n \"department:engineering\"\n ],\n \"env\": \"staging\",\n \"finished_at\": 1693491984000000000,\n \"git\": {\n \"repository_url\": \"https://github.com/organization/example-repository\",\n \"commit_sha\": \"66adc9350f2cc9b250b69abddab733dd55e1a588\"\n },\n \"id\": \"est non\",\n \"name\": \"Webserver is down failing all requests.\",\n \"services\": [\n \"shopist\"\n ],\n \"severity\": \"High\",\n \"team\": \"backend\",\n \"version\": \"v1.12.07\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failure"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sit_2\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"non_a\": {},\n \"in_1\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"started_at\": 1693491974000000000,\n \"custom_tags\": [\n \"language:java\",\n \"department:engineering\"\n ],\n \"env\": \"staging\",\n \"finished_at\": 1693491984000000000,\n \"git\": {\n \"repository_url\": \"https://github.com/organization/example-repository\",\n \"commit_sha\": \"66adc9350f2cc9b250b69abddab733dd55e1a588\"\n },\n \"id\": \"est non\",\n \"name\": \"Webserver is down failing all requests.\",\n \"services\": [\n \"shopist\"\n ],\n \"severity\": \"High\",\n \"team\": \"backend\",\n \"version\": \"v1.12.07\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failure"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"started_at\": 1693491974000000000,\n \"custom_tags\": [\n \"language:java\",\n \"department:engineering\"\n ],\n \"env\": \"staging\",\n \"finished_at\": 1693491984000000000,\n \"git\": {\n \"repository_url\": \"https://github.com/organization/example-repository\",\n \"commit_sha\": \"66adc9350f2cc9b250b69abddab733dd55e1a588\"\n },\n \"id\": \"est non\",\n \"name\": \"Webserver is down failing all requests.\",\n \"services\": [\n \"shopist\"\n ],\n \"severity\": \"High\",\n \"team\": \"backend\",\n \"version\": \"v1.12.07\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failure",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failure"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a list of deployment events",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"from\": \"1964-05-25T08:24:42.172Z\",\n \"limit\": 10,\n \"query\": \"est dolor commodo\",\n \"sort\": \"sed culpa ea\",\n \"to\": \"2002-06-04T15:13:17.353Z\"\n },\n \"type\": \"dora_deployments_list_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployments",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployments"
]
},
"description": "Use this API endpoint to get a list of deployment events."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"from\": \"1964-05-25T08:24:42.172Z\",\n \"limit\": 10,\n \"query\": \"est dolor commodo\",\n \"sort\": \"sed culpa ea\",\n \"to\": \"2002-06-04T15:13:17.353Z\"\n },\n \"type\": \"dora_deployments_list_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployments",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployments"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {},\n \"id\": \"cupidatat elit proident\",\n \"type\": \"ut occaecat ex fugiat cillum\"\n },\n {\n \"attributes\": {},\n \"id\": \"Excepteur consectetur quis\",\n \"type\": \"dolore commodo ipsum sint\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"from\": \"1964-05-25T08:24:42.172Z\",\n \"limit\": 10,\n \"query\": \"est dolor commodo\",\n \"sort\": \"sed culpa ea\",\n \"to\": \"2002-06-04T15:13:17.353Z\"\n },\n \"type\": \"dora_deployments_list_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployments",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployments"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sit_2\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"non_a\": {},\n \"in_1\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"from\": \"1964-05-25T08:24:42.172Z\",\n \"limit\": 10,\n \"query\": \"est dolor commodo\",\n \"sort\": \"sed culpa ea\",\n \"to\": \"2002-06-04T15:13:17.353Z\"\n },\n \"type\": \"dora_deployments_list_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployments",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployments"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"from\": \"1964-05-25T08:24:42.172Z\",\n \"limit\": 10,\n \"query\": \"est dolor commodo\",\n \"sort\": \"sed culpa ea\",\n \"to\": \"2002-06-04T15:13:17.353Z\"\n },\n \"type\": \"dora_deployments_list_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployments",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployments"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a list of failure events",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"from\": \"1995-02-20T06:40:50.939Z\",\n \"limit\": 10,\n \"query\": \"ipsum do\",\n \"sort\": \"laboris\",\n \"to\": \"1949-10-02T13:22:43.367Z\"\n },\n \"type\": \"dora_failures_list_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failures",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failures"
]
},
"description": "Use this API endpoint to get a list of failure events."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"from\": \"1995-02-20T06:40:50.939Z\",\n \"limit\": 10,\n \"query\": \"ipsum do\",\n \"sort\": \"laboris\",\n \"to\": \"1949-10-02T13:22:43.367Z\"\n },\n \"type\": \"dora_failures_list_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failures",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failures"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {},\n \"id\": \"cupidatat elit proident\",\n \"type\": \"ut occaecat ex fugiat cillum\"\n },\n {\n \"attributes\": {},\n \"id\": \"Excepteur consectetur quis\",\n \"type\": \"dolore commodo ipsum sint\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"from\": \"1995-02-20T06:40:50.939Z\",\n \"limit\": 10,\n \"query\": \"ipsum do\",\n \"sort\": \"laboris\",\n \"to\": \"1949-10-02T13:22:43.367Z\"\n },\n \"type\": \"dora_failures_list_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failures",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failures"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sit_2\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"non_a\": {},\n \"in_1\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"from\": \"1995-02-20T06:40:50.939Z\",\n \"limit\": 10,\n \"query\": \"ipsum do\",\n \"sort\": \"laboris\",\n \"to\": \"1949-10-02T13:22:43.367Z\"\n },\n \"type\": \"dora_failures_list_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failures",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failures"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"from\": \"1995-02-20T06:40:50.939Z\",\n \"limit\": 10,\n \"query\": \"ipsum do\",\n \"sort\": \"laboris\",\n \"to\": \"1949-10-02T13:22:43.367Z\"\n },\n \"type\": \"dora_failures_list_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failures",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failures"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a deployment event",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployments/:deployment_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployments",
":deployment_id"
],
"variable": [
{
"key": "deployment_id",
"value": "esse commodo"
}
]
},
"description": "Use this API endpoint to get a deployment event."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployments/:deployment_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployments",
":deployment_id"
],
"variable": [
{
"key": "deployment_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {},\n \"id\": \"ullamco cillum elit\",\n \"type\": \"cillum\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployments/:deployment_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployments",
":deployment_id"
],
"variable": [
{
"key": "deployment_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sit_2\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"non_a\": {},\n \"in_1\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployments/:deployment_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployments",
":deployment_id"
],
"variable": [
{
"key": "deployment_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dora/deployments/:deployment_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"deployments",
":deployment_id"
],
"variable": [
{
"key": "deployment_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a failure event",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failures/:failure_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failures",
":failure_id"
],
"variable": [
{
"key": "failure_id",
"value": "esse commodo"
}
]
},
"description": "Use this API endpoint to get a failure event."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failures/:failure_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failures",
":failure_id"
],
"variable": [
{
"key": "failure_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {},\n \"id\": \"ullamco cillum elit\",\n \"type\": \"cillum\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failures/:failure_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failures",
":failure_id"
],
"variable": [
{
"key": "failure_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sit_2\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"non_a\": {},\n \"in_1\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failures/:failure_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failures",
":failure_id"
],
"variable": [
{
"key": "failure_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dora/failures/:failure_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dora",
"failures",
":failure_id"
],
"variable": [
{
"key": "failure_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Search or send events for DORA Metrics to measure and improve your software delivery performance. See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/) for more information.\n\n**Note**: DORA Metrics are not available in the US1-FED site.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Downtimes",
"item": [
{
"name": "Get all downtimes",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
],
"query": [
{
"key": "current_only",
"value": "false",
"description": "Only return downtimes that are active when the request is made.",
"disabled": true
},
{
"key": "include",
"value": "created_by,monitor",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`.",
"disabled": true
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page.",
"disabled": true
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of downtimes in the response.",
"disabled": true
}
]
},
"description": "Get all scheduled downtimes."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
],
"query": [
{
"key": "current_only",
"value": "false",
"description": "Only return downtimes that are active when the request is made.",
"disabled": true
},
{
"key": "include",
"value": "created_by,monitor",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`.",
"disabled": true
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page.",
"disabled": true
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of downtimes in the response.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"canceled\": \"2020-01-02T03:04:05.282979+0000\",\n \"created\": \"2020-01-02T03:04:05.282979+0000\",\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"modified\": \"2020-01-02T03:04:05.282979+0000\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"current_downtime\": {\n \"end\": \"2020-01-02T03:04:00.000Z\",\n \"start\": \"2020-01-02T03:04:00.000Z\"\n },\n \"timezone\": \"America/New_York\"\n },\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\",\n \"status\": \"active\"\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"users\"\n }\n },\n \"monitor\": {\n \"data\": {\n \"id\": \"12345\",\n \"type\": \"monitors\"\n }\n }\n },\n \"type\": \"downtime\"\n },\n {\n \"attributes\": {\n \"canceled\": \"2020-01-02T03:04:05.282979+0000\",\n \"created\": \"2020-01-02T03:04:05.282979+0000\",\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"modified\": \"2020-01-02T03:04:05.282979+0000\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"current_downtime\": {\n \"end\": \"2020-01-02T03:04:00.000Z\",\n \"start\": \"2020-01-02T03:04:00.000Z\"\n },\n \"timezone\": \"America/New_York\"\n },\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\",\n \"status\": \"active\"\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"users\"\n }\n },\n \"monitor\": {\n \"data\": {\n \"id\": \"12345\",\n \"type\": \"monitors\"\n }\n }\n },\n \"type\": \"downtime\"\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1955-04-22T16:11:51.568Z\",\n \"disabled\": false,\n \"email\": \"esse ut\",\n \"handle\": \"des\",\n \"icon\": \"sed Excepteur ex\",\n \"modified_at\": \"2010-07-30T04:31:51.727Z\",\n \"name\": \"consequat anim\",\n \"service_account\": false,\n \"status\": \"quis elit id adipisicing voluptate\",\n \"title\": \"amet magna nostrud\",\n \"verified\": false\n },\n \"id\": \"adipisicing sed\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1961-04-17T07:59:29.050Z\",\n \"disabled\": false,\n \"email\": \"eu\",\n \"handle\": \"amet\",\n \"icon\": \"proident ipsum labore pariatur do\",\n \"modified_at\": \"1957-12-19T08:55:09.761Z\",\n \"name\": \"anim Exce\",\n \"service_account\": false,\n \"status\": \"eli\",\n \"title\": \"commodo Excepteur in\",\n \"verified\": false\n },\n \"id\": \"reprehenderit sint sit et Lorem\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_filtered_count\": 43080922\n }\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
],
"query": [
{
"key": "current_only",
"value": "false",
"description": "Only return downtimes that are active when the request is made.",
"disabled": true
},
{
"key": "include",
"value": "created_by,monitor",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`.",
"disabled": true
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page.",
"disabled": true
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of downtimes in the response.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
],
"query": [
{
"key": "current_only",
"value": "false",
"description": "Only return downtimes that are active when the request is made.",
"disabled": true
},
{
"key": "include",
"value": "created_by,monitor",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`.",
"disabled": true
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page.",
"disabled": true
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of downtimes in the response.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Schedule a downtime",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"downtime\",\n \"attributes\": {\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n },\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"timezone\": \"America/New_York\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
]
},
"description": "Schedule a downtime."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"downtime\",\n \"attributes\": {\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n },\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"timezone\": \"America/New_York\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"canceled\": \"2020-01-02T03:04:05.282979+0000\",\n \"created\": \"2020-01-02T03:04:05.282979+0000\",\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"modified\": \"2020-01-02T03:04:05.282979+0000\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"current_downtime\": {\n \"end\": \"2020-01-02T03:04:00.000Z\",\n \"start\": \"2020-01-02T03:04:00.000Z\"\n },\n \"timezone\": \"America/New_York\"\n },\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\",\n \"status\": \"active\"\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"users\"\n }\n },\n \"monitor\": {\n \"data\": {\n \"id\": \"12345\",\n \"type\": \"monitors\"\n }\n }\n },\n \"type\": \"downtime\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1991-09-04T01:17:36.668Z\",\n \"disabled\": false,\n \"email\": \"minim\",\n \"handle\": \"in fugiat Ut\",\n \"icon\": \"dolore nostrud\",\n \"modified_at\": \"1948-02-16T11:04:06.701Z\",\n \"name\": \"aliqua adipisicing labore ut\",\n \"service_account\": true,\n \"status\": \"aute Excepteur\",\n \"title\": \"velit pariatur quis\",\n \"verified\": true\n },\n \"id\": \"ad in\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1981-01-28T15:38:15.884Z\",\n \"disabled\": true,\n \"email\": \"Excepteur non\",\n \"handle\": \"irure culpa pariatur\",\n \"icon\": \"sit aliquip amet quis\",\n \"modified_at\": \"2017-12-22T11:05:10.255Z\",\n \"name\": \"cillum\",\n \"service_account\": false,\n \"status\": \"aliquip irure\",\n \"title\": \"ea aliquip esse\",\n \"verified\": false\n },\n \"id\": \"non\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"downtime\",\n \"attributes\": {\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n },\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"timezone\": \"America/New_York\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"downtime\",\n \"attributes\": {\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n },\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"timezone\": \"America/New_York\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"downtime\",\n \"attributes\": {\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n },\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"timezone\": \"America/New_York\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Cancel a downtime",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"variable": [
{
"key": "downtime_id",
"value": "00000000-0000-1234-0000-000000000000"
}
]
},
"description": "Cancel a downtime."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Downtime not found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a downtime",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"key": "include",
"value": "created_by,monitor",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`.",
"disabled": true
}
],
"variable": [
{
"key": "downtime_id",
"value": "00000000-0000-1234-0000-000000000000"
}
]
},
"description": "Get downtime detail by `downtime_id`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"key": "include",
"value": "created_by,monitor",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`.",
"disabled": true
}
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"canceled\": \"2020-01-02T03:04:05.282979+0000\",\n \"created\": \"2020-01-02T03:04:05.282979+0000\",\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"modified\": \"2020-01-02T03:04:05.282979+0000\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"current_downtime\": {\n \"end\": \"2020-01-02T03:04:00.000Z\",\n \"start\": \"2020-01-02T03:04:00.000Z\"\n },\n \"timezone\": \"America/New_York\"\n },\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\",\n \"status\": \"active\"\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"users\"\n }\n },\n \"monitor\": {\n \"data\": {\n \"id\": \"12345\",\n \"type\": \"monitors\"\n }\n }\n },\n \"type\": \"downtime\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1991-09-04T01:17:36.668Z\",\n \"disabled\": false,\n \"email\": \"minim\",\n \"handle\": \"in fugiat Ut\",\n \"icon\": \"dolore nostrud\",\n \"modified_at\": \"1948-02-16T11:04:06.701Z\",\n \"name\": \"aliqua adipisicing labore ut\",\n \"service_account\": true,\n \"status\": \"aute Excepteur\",\n \"title\": \"velit pariatur quis\",\n \"verified\": true\n },\n \"id\": \"ad in\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1981-01-28T15:38:15.884Z\",\n \"disabled\": true,\n \"email\": \"Excepteur non\",\n \"handle\": \"irure culpa pariatur\",\n \"icon\": \"sit aliquip amet quis\",\n \"modified_at\": \"2017-12-22T11:05:10.255Z\",\n \"name\": \"cillum\",\n \"service_account\": false,\n \"status\": \"aliquip irure\",\n \"title\": \"ea aliquip esse\",\n \"verified\": false\n },\n \"id\": \"non\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"key": "include",
"value": "created_by,monitor",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`.",
"disabled": true
}
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"key": "include",
"value": "created_by,monitor",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`.",
"disabled": true
}
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"key": "include",
"value": "created_by,monitor",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`.",
"disabled": true
}
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"key": "include",
"value": "created_by,monitor",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`.",
"disabled": true
}
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a downtime",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"downtime\",\n \"attributes\": {\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n },\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"variable": [
{
"key": "downtime_id",
"value": "00e000000-0000-1234-0000-000000000000"
}
]
},
"description": "Update a downtime by `downtime_id`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"downtime\",\n \"attributes\": {\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n },\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"canceled\": \"2020-01-02T03:04:05.282979+0000\",\n \"created\": \"2020-01-02T03:04:05.282979+0000\",\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"modified\": \"2020-01-02T03:04:05.282979+0000\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"current_downtime\": {\n \"end\": \"2020-01-02T03:04:00.000Z\",\n \"start\": \"2020-01-02T03:04:00.000Z\"\n },\n \"timezone\": \"America/New_York\"\n },\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\",\n \"status\": \"active\"\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"users\"\n }\n },\n \"monitor\": {\n \"data\": {\n \"id\": \"12345\",\n \"type\": \"monitors\"\n }\n }\n },\n \"type\": \"downtime\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1991-09-04T01:17:36.668Z\",\n \"disabled\": false,\n \"email\": \"minim\",\n \"handle\": \"in fugiat Ut\",\n \"icon\": \"dolore nostrud\",\n \"modified_at\": \"1948-02-16T11:04:06.701Z\",\n \"name\": \"aliqua adipisicing labore ut\",\n \"service_account\": true,\n \"status\": \"aute Excepteur\",\n \"title\": \"velit pariatur quis\",\n \"verified\": true\n },\n \"id\": \"ad in\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1981-01-28T15:38:15.884Z\",\n \"disabled\": true,\n \"email\": \"Excepteur non\",\n \"handle\": \"irure culpa pariatur\",\n \"icon\": \"sit aliquip amet quis\",\n \"modified_at\": \"2017-12-22T11:05:10.255Z\",\n \"name\": \"cillum\",\n \"service_account\": false,\n \"status\": \"aliquip irure\",\n \"title\": \"ea aliquip esse\",\n \"verified\": false\n },\n \"id\": \"non\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"downtime\",\n \"attributes\": {\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n },\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"downtime\",\n \"attributes\": {\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n },\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Downtime not found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"downtime\",\n \"attributes\": {\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n },\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"downtime\",\n \"attributes\": {\n \"display_timezone\": \"America/New_York\",\n \"message\": \"Message about the downtime\",\n \"monitor_identifier\": {\n \"monitor_id\": 123\n },\n \"mute_first_recovery_notification\": false,\n \"notify_end_states\": [\n \"alert\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n },\n {\n \"duration\": \"123d\",\n \"rrule\": \"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\",\n \"start\": \"2020-01-02T03:04\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get active downtimes for a monitor",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/:monitor_id/downtime_matches",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
":monitor_id",
"downtime_matches"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page.",
"disabled": true
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of downtimes in the response.",
"disabled": true
}
],
"variable": [
{
"key": "monitor_id",
"value": "97337406"
}
]
},
"description": "Get all active downtimes for the specified monitor."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/:monitor_id/downtime_matches",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
":monitor_id",
"downtime_matches"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page.",
"disabled": true
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of downtimes in the response.",
"disabled": true
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"end\": \"2020-01-02T03:04:00.000Z\",\n \"groups\": [\n \"service:postgres\",\n \"team:frontend\"\n ],\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\",\n \"start\": \"2020-01-02T03:04:00.000Z\"\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"downtime_match\"\n },\n {\n \"attributes\": {\n \"end\": \"2020-01-02T03:04:00.000Z\",\n \"groups\": [\n \"service:postgres\",\n \"team:frontend\"\n ],\n \"scope\": \"env:(staging OR prod) AND datacenter:us-east-1\",\n \"start\": \"2020-01-02T03:04:00.000Z\"\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"downtime_match\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_filtered_count\": 27755850\n }\n }\n}"
},
{
"name": "Monitor Not Found error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/:monitor_id/downtime_matches",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
":monitor_id",
"downtime_matches"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page.",
"disabled": true
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of downtimes in the response.",
"disabled": true
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/:monitor_id/downtime_matches",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
":monitor_id",
"downtime_matches"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page.",
"disabled": true
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of downtimes in the response.",
"disabled": true
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "**Note**: Downtime V2 is currently in private beta. To request access, contact [Datadog support](https://docs.datadoghq.com/help/).\n\n[Downtiming](https://docs.datadoghq.com/monitors/notify/downtimes) gives\nyou greater control over monitor notifications by allowing you to globally exclude\nscopes from alerting. Downtime settings, which can be scheduled with start and\nend times, prevent all alerting related to specified Datadog tags.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Embeddable Graphs",
"item": [
{
"name": "Get all embeds",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed"
]
},
"description": "Gets a list of previously created embeddable graphs."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"embedded_graphs\": [\n {\n \"dash_name\": \"l\",\n \"dash_url\": \"laborum cillum\",\n \"embed_id\": \"irure reprehenderit\",\n \"graph_title\": \"consectetur\",\n \"html\": \"dolor\",\n \"revoked\": true,\n \"shared_by\": 6511234\n },\n {\n \"dash_name\": \"culpa sed laborum reprehenderit do\",\n \"dash_url\": \"sunt\",\n \"embed_id\": \"est exercitation aute ex consectetur\",\n \"graph_title\": \"in consectetur Lorem ex commodo\",\n \"html\": \"proident laborum\",\n \"revoked\": true,\n \"shared_by\": -26399485\n }\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create embed",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"graph_json\": \"\",\n \"legend\": \"no\",\n \"size\": \"medium\",\n \"timeframe\": \"1_hour\",\n \"title\": \"Embed created through API\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed"
]
},
"description": "Creates a new embeddable graph.\n\nNote: If an embed already exists for the exact same query in a given organization,\nthe older embed is returned instead of creating a new embed.\n\nIf you are interested in using template variables, see\n[Embeddable Graphs with Template Variables](https://docs.datadoghq.com/dashboards/faq/embeddable-graphs-with-template-variables)."
},
"response": [
{
"name": "Payload accepted",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"graph_json\": \"\",\n \"legend\": \"no\",\n \"size\": \"medium\",\n \"timeframe\": \"1_hour\",\n \"title\": \"Embed created through API\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"dash_name\": \"nostrud consequat\",\n \"dash_url\": \"labore commodo\",\n \"embed_id\": \"officia dolor deserunt ipsum\",\n \"graph_title\": \"qui eu aliqua et\",\n \"html\": \"eu\",\n \"revoked\": false,\n \"shared_by\": -79332285\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"graph_json\": \"\",\n \"legend\": \"no\",\n \"size\": \"medium\",\n \"timeframe\": \"1_hour\",\n \"title\": \"Embed created through API\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"graph_json\": \"\",\n \"legend\": \"no\",\n \"size\": \"medium\",\n \"timeframe\": \"1_hour\",\n \"title\": \"Embed created through API\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"graph_json\": \"\",\n \"legend\": \"no\",\n \"size\": \"medium\",\n \"timeframe\": \"1_hour\",\n \"title\": \"Embed created through API\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get specific embed",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed/:embed_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed",
":embed_id"
],
"variable": [
{
"key": "embed_id",
"value": "pariatur"
}
]
},
"description": "Get the HTML fragment for a previously generated embed with `embed_id`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed/:embed_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed",
":embed_id"
],
"variable": [
{
"key": "embed_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"dash_name\": \"nostrud consequat\",\n \"dash_url\": \"labore commodo\",\n \"embed_id\": \"officia dolor deserunt ipsum\",\n \"graph_title\": \"qui eu aliqua et\",\n \"html\": \"eu\",\n \"revoked\": false,\n \"shared_by\": -79332285\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed/:embed_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed",
":embed_id"
],
"variable": [
{
"key": "embed_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed/:embed_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed",
":embed_id"
],
"variable": [
{
"key": "embed_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed/:embed_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed",
":embed_id"
],
"variable": [
{
"key": "embed_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Enable embed",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed/:embed_id/enable",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed",
":embed_id",
"enable"
],
"variable": [
{
"key": "embed_id",
"value": "pariatur"
}
]
},
"description": "Enable a specified embed."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed/:embed_id/enable",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed",
":embed_id",
"enable"
],
"variable": [
{
"key": "embed_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"Embed 00000000000 successfully enabled.\"\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed/:embed_id/enable",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed",
":embed_id",
"enable"
],
"variable": [
{
"key": "embed_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed/:embed_id/enable",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed",
":embed_id",
"enable"
],
"variable": [
{
"key": "embed_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed/:embed_id/enable",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed",
":embed_id",
"enable"
],
"variable": [
{
"key": "embed_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Revoke embed",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed/:embed_id/revoke",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed",
":embed_id",
"revoke"
],
"variable": [
{
"key": "embed_id",
"value": "pariatur"
}
]
},
"description": "Revoke a specified embed."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed/:embed_id/revoke",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed",
":embed_id",
"revoke"
],
"variable": [
{
"key": "embed_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"Embed 0000000000000 successfully revoked.\"\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed/:embed_id/revoke",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed",
":embed_id",
"revoke"
],
"variable": [
{
"key": "embed_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed/:embed_id/revoke",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed",
":embed_id",
"revoke"
],
"variable": [
{
"key": "embed_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/embed/:embed_id/revoke",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"embed",
":embed_id",
"revoke"
],
"variable": [
{
"key": "embed_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Manage embeddable graphs through the API. See [Embeddable Graphs with Template Variables](https://docs.datadoghq.com/dashboards/guide/embeddable-graphs-with-template-variables/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Error Tracking",
"item": [
{
"name": "Search error tracking issues",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"search_request\",\n \"attributes\": {\n \"query\": \"service:orders-* AND @language:go\",\n \"from\": 1671612804000,\n \"to\": 1671620004000,\n \"order_by\": \"IMPACTED_SESSIONS\",\n \"persona\": \"BACKEND\",\n \"track\": \"trace\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/search?include=issue.case,issue.case",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
"search"
],
"query": [
{
"key": "include",
"value": "issue.case,issue.case",
"description": "Comma-separated list of relationship objects that should be included in the response."
}
]
},
"description": "Search issues endpoint allows you to programmatically search for issues within your organization. This endpoint returns a list of issues that match a given search query, following the event search syntax. The search results are limited to a maximum of 100 issues per request."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"search_request\",\n \"attributes\": {\n \"query\": \"service:orders-* AND @language:go\",\n \"from\": 1671612804000,\n \"to\": 1671620004000,\n \"order_by\": \"IMPACTED_SESSIONS\",\n \"persona\": \"BACKEND\",\n \"track\": \"trace\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/search?include=issue.case,issue.case",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
"search"
],
"query": [
{
"key": "include",
"value": "issue.case,issue.case",
"description": "Comma-separated list of relationship objects that should be included in the response."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"error_tracking_search_result\",\n \"attributes\": {\n \"impacted_sessions\": 12,\n \"impacted_users\": 4,\n \"total_count\": 82\n },\n \"relationships\": {\n \"issue\": {\n \"data\": {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"issue\"\n }\n }\n }\n },\n {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"error_tracking_search_result\",\n \"attributes\": {\n \"impacted_sessions\": 12,\n \"impacted_users\": 4,\n \"total_count\": 82\n },\n \"relationships\": {\n \"issue\": {\n \"data\": {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"issue\"\n }\n }\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"issue\",\n \"attributes\": {\n \"error_message\": \"object of type 'NoneType' has no len()\",\n \"error_type\": \"builtins.TypeError\",\n \"file_path\": \"/django-email/conduit/apps/core/utils.py\",\n \"first_seen\": 1671612804001,\n \"first_seen_version\": \"aaf65cd0\",\n \"function_name\": \"filter_forbidden_tags\",\n \"is_crash\": false,\n \"languages\": [\n \"PYTHON\",\n \"GO\"\n ],\n \"last_seen\": 1671620003100,\n \"last_seen_version\": \"b6199f80\",\n \"platform\": \"BACKEND\",\n \"service\": \"email-api-py\",\n \"state\": \"RESOLVED\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"87cb11a0-278c-440a-99fe-701223c80296\",\n \"type\": \"user\"\n }\n },\n \"case\": {\n \"data\": {\n \"id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"case\"\n }\n },\n \"team_owners\": {\n \"data\": [\n {\n \"id\": \"221b0179-6447-4d03-91c3-3ca98bf60e8a\",\n \"type\": \"team\"\n },\n {\n \"id\": \"221b0179-6447-4d03-91c3-3ca98bf60e8a\",\n \"type\": \"team\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"issue\",\n \"attributes\": {\n \"error_message\": \"object of type 'NoneType' has no len()\",\n \"error_type\": \"builtins.TypeError\",\n \"file_path\": \"/django-email/conduit/apps/core/utils.py\",\n \"first_seen\": 1671612804001,\n \"first_seen_version\": \"aaf65cd0\",\n \"function_name\": \"filter_forbidden_tags\",\n \"is_crash\": false,\n \"languages\": [\n \"PYTHON\",\n \"GO\"\n ],\n \"last_seen\": 1671620003100,\n \"last_seen_version\": \"b6199f80\",\n \"platform\": \"BACKEND\",\n \"service\": \"email-api-py\",\n \"state\": \"RESOLVED\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"87cb11a0-278c-440a-99fe-701223c80296\",\n \"type\": \"user\"\n }\n },\n \"case\": {\n \"data\": {\n \"id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"case\"\n }\n },\n \"team_owners\": {\n \"data\": [\n {\n \"id\": \"221b0179-6447-4d03-91c3-3ca98bf60e8a\",\n \"type\": \"team\"\n },\n {\n \"id\": \"221b0179-6447-4d03-91c3-3ca98bf60e8a\",\n \"type\": \"team\"\n }\n ]\n }\n }\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"search_request\",\n \"attributes\": {\n \"query\": \"service:orders-* AND @language:go\",\n \"from\": 1671612804000,\n \"to\": 1671620004000,\n \"order_by\": \"IMPACTED_SESSIONS\",\n \"persona\": \"BACKEND\",\n \"track\": \"trace\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/search?include=issue.case,issue.case",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
"search"
],
"query": [
{
"key": "include",
"value": "issue.case,issue.case",
"description": "Comma-separated list of relationship objects that should be included in the response."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"search_request\",\n \"attributes\": {\n \"query\": \"service:orders-* AND @language:go\",\n \"from\": 1671612804000,\n \"to\": 1671620004000,\n \"order_by\": \"IMPACTED_SESSIONS\",\n \"persona\": \"BACKEND\",\n \"track\": \"trace\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/search?include=issue.case,issue.case",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
"search"
],
"query": [
{
"key": "include",
"value": "issue.case,issue.case",
"description": "Comma-separated list of relationship objects that should be included in the response."
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"search_request\",\n \"attributes\": {\n \"query\": \"service:orders-* AND @language:go\",\n \"from\": 1671612804000,\n \"to\": 1671620004000,\n \"order_by\": \"IMPACTED_SESSIONS\",\n \"persona\": \"BACKEND\",\n \"track\": \"trace\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/search?include=issue.case,issue.case",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
"search"
],
"query": [
{
"key": "include",
"value": "issue.case,issue.case",
"description": "Comma-separated list of relationship objects that should be included in the response."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"search_request\",\n \"attributes\": {\n \"query\": \"service:orders-* AND @language:go\",\n \"from\": 1671612804000,\n \"to\": 1671620004000,\n \"order_by\": \"IMPACTED_SESSIONS\",\n \"persona\": \"BACKEND\",\n \"track\": \"trace\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/search?include=issue.case,issue.case",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
"search"
],
"query": [
{
"key": "include",
"value": "issue.case,issue.case",
"description": "Comma-separated list of relationship objects that should be included in the response."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get the details of an error tracking issue",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id?include=case,case",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id"
],
"query": [
{
"key": "include",
"value": "case,case",
"description": "Comma-separated list of relationship objects that should be included in the response."
}
],
"variable": [
{
"key": "issue_id",
"value": "c1726a66-1f64-11ee-b338-da7ad0900002"
}
]
},
"description": "Retrieve the full details for a specific error tracking issue, including attributes and relationships."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id?include=case,case",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id"
],
"query": [
{
"key": "include",
"value": "case,case",
"description": "Comma-separated list of relationship objects that should be included in the response."
}
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"issue\",\n \"attributes\": {\n \"error_message\": \"object of type 'NoneType' has no len()\",\n \"error_type\": \"builtins.TypeError\",\n \"file_path\": \"/django-email/conduit/apps/core/utils.py\",\n \"first_seen\": 1671612804001,\n \"first_seen_version\": \"aaf65cd0\",\n \"function_name\": \"filter_forbidden_tags\",\n \"is_crash\": false,\n \"languages\": [\n \"PYTHON\",\n \"GO\"\n ],\n \"last_seen\": 1671620003100,\n \"last_seen_version\": \"b6199f80\",\n \"platform\": \"BACKEND\",\n \"service\": \"email-api-py\",\n \"state\": \"RESOLVED\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"87cb11a0-278c-440a-99fe-701223c80296\",\n \"type\": \"user\"\n }\n },\n \"case\": {\n \"data\": {\n \"id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"case\"\n }\n },\n \"team_owners\": {\n \"data\": [\n {\n \"id\": \"221b0179-6447-4d03-91c3-3ca98bf60e8a\",\n \"type\": \"team\"\n },\n {\n \"id\": \"221b0179-6447-4d03-91c3-3ca98bf60e8a\",\n \"type\": \"team\"\n }\n ]\n }\n }\n },\n \"included\": [\n {\n \"id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2025-01-01T00:00:00Z\",\n \"closed_at\": \"2025-01-01T00:00:00Z\",\n \"created_at\": \"2025-01-01T00:00:00Z\",\n \"creation_source\": \"ERROR_TRACKING\",\n \"description\": \"elit minim\",\n \"due_date\": \"2025-01-01\",\n \"insights\": [\n {\n \"ref\": \"/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"resource_id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"ERROR_TRACKING\"\n },\n {\n \"ref\": \"/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"resource_id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"ERROR_TRACKING\"\n }\n ],\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"1904866\",\n \"issue_key\": \"ET-123\",\n \"issue_url\": \"https://your-jira-instance.atlassian.net/browse/ET-123\",\n \"project_key\": \"ET\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"ET-123\",\n \"modified_at\": \"2025-01-01T00:00:00Z\",\n \"priority\": \"NOT_DEFINED\",\n \"status\": \"OPEN\",\n \"title\": \"Error: HTTP error\",\n \"type\": \"ERROR_TRACKING_ISSUE\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n },\n {\n \"id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2025-01-01T00:00:00Z\",\n \"closed_at\": \"2025-01-01T00:00:00Z\",\n \"created_at\": \"2025-01-01T00:00:00Z\",\n \"creation_source\": \"ERROR_TRACKING\",\n \"description\": \"commodo\",\n \"due_date\": \"2025-01-01\",\n \"insights\": [\n {\n \"ref\": \"/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"resource_id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"ERROR_TRACKING\"\n },\n {\n \"ref\": \"/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"resource_id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"ERROR_TRACKING\"\n }\n ],\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"1904866\",\n \"issue_key\": \"ET-123\",\n \"issue_url\": \"https://your-jira-instance.atlassian.net/browse/ET-123\",\n \"project_key\": \"ET\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"ET-123\",\n \"modified_at\": \"2025-01-01T00:00:00Z\",\n \"priority\": \"NOT_DEFINED\",\n \"status\": \"OPEN\",\n \"title\": \"Error: HTTP error\",\n \"type\": \"ERROR_TRACKING_ISSUE\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id?include=case,case",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id"
],
"query": [
{
"key": "include",
"value": "case,case",
"description": "Comma-separated list of relationship objects that should be included in the response."
}
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id?include=case,case",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id"
],
"query": [
{
"key": "include",
"value": "case,case",
"description": "Comma-separated list of relationship objects that should be included in the response."
}
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id?include=case,case",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id"
],
"query": [
{
"key": "include",
"value": "case,case",
"description": "Comma-separated list of relationship objects that should be included in the response."
}
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id?include=case,case",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id"
],
"query": [
{
"key": "include",
"value": "case,case",
"description": "Comma-separated list of relationship objects that should be included in the response."
}
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id?include=case,case",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id"
],
"query": [
{
"key": "include",
"value": "case,case",
"description": "Comma-separated list of relationship objects that should be included in the response."
}
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update the state of an issue",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"error_tracking_issue\",\n \"attributes\": {\n \"state\": \"RESOLVED\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id/state",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id",
"state"
],
"variable": [
{
"key": "issue_id",
"value": "c1726a66-1f64-11ee-b338-da7ad0900002"
}
]
},
"description": "Update the state of an issue by `issue_id`. Use this endpoint to move an issue between states such as `OPEN`, `RESOLVED`, or `IGNORED`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"error_tracking_issue\",\n \"attributes\": {\n \"state\": \"RESOLVED\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id/state",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id",
"state"
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"issue\",\n \"attributes\": {\n \"error_message\": \"object of type 'NoneType' has no len()\",\n \"error_type\": \"builtins.TypeError\",\n \"file_path\": \"/django-email/conduit/apps/core/utils.py\",\n \"first_seen\": 1671612804001,\n \"first_seen_version\": \"aaf65cd0\",\n \"function_name\": \"filter_forbidden_tags\",\n \"is_crash\": false,\n \"languages\": [\n \"PYTHON\",\n \"GO\"\n ],\n \"last_seen\": 1671620003100,\n \"last_seen_version\": \"b6199f80\",\n \"platform\": \"BACKEND\",\n \"service\": \"email-api-py\",\n \"state\": \"RESOLVED\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"87cb11a0-278c-440a-99fe-701223c80296\",\n \"type\": \"user\"\n }\n },\n \"case\": {\n \"data\": {\n \"id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"case\"\n }\n },\n \"team_owners\": {\n \"data\": [\n {\n \"id\": \"221b0179-6447-4d03-91c3-3ca98bf60e8a\",\n \"type\": \"team\"\n },\n {\n \"id\": \"221b0179-6447-4d03-91c3-3ca98bf60e8a\",\n \"type\": \"team\"\n }\n ]\n }\n }\n },\n \"included\": [\n {\n \"id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2025-01-01T00:00:00Z\",\n \"closed_at\": \"2025-01-01T00:00:00Z\",\n \"created_at\": \"2025-01-01T00:00:00Z\",\n \"creation_source\": \"ERROR_TRACKING\",\n \"description\": \"elit minim\",\n \"due_date\": \"2025-01-01\",\n \"insights\": [\n {\n \"ref\": \"/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"resource_id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"ERROR_TRACKING\"\n },\n {\n \"ref\": \"/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"resource_id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"ERROR_TRACKING\"\n }\n ],\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"1904866\",\n \"issue_key\": \"ET-123\",\n \"issue_url\": \"https://your-jira-instance.atlassian.net/browse/ET-123\",\n \"project_key\": \"ET\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"ET-123\",\n \"modified_at\": \"2025-01-01T00:00:00Z\",\n \"priority\": \"NOT_DEFINED\",\n \"status\": \"OPEN\",\n \"title\": \"Error: HTTP error\",\n \"type\": \"ERROR_TRACKING_ISSUE\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n },\n {\n \"id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2025-01-01T00:00:00Z\",\n \"closed_at\": \"2025-01-01T00:00:00Z\",\n \"created_at\": \"2025-01-01T00:00:00Z\",\n \"creation_source\": \"ERROR_TRACKING\",\n \"description\": \"commodo\",\n \"due_date\": \"2025-01-01\",\n \"insights\": [\n {\n \"ref\": \"/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"resource_id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"ERROR_TRACKING\"\n },\n {\n \"ref\": \"/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"resource_id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"ERROR_TRACKING\"\n }\n ],\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"1904866\",\n \"issue_key\": \"ET-123\",\n \"issue_url\": \"https://your-jira-instance.atlassian.net/browse/ET-123\",\n \"project_key\": \"ET\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"ET-123\",\n \"modified_at\": \"2025-01-01T00:00:00Z\",\n \"priority\": \"NOT_DEFINED\",\n \"status\": \"OPEN\",\n \"title\": \"Error: HTTP error\",\n \"type\": \"ERROR_TRACKING_ISSUE\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"error_tracking_issue\",\n \"attributes\": {\n \"state\": \"RESOLVED\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id/state",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id",
"state"
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"error_tracking_issue\",\n \"attributes\": {\n \"state\": \"RESOLVED\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id/state",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id",
"state"
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"error_tracking_issue\",\n \"attributes\": {\n \"state\": \"RESOLVED\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id/state",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id",
"state"
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"error_tracking_issue\",\n \"attributes\": {\n \"state\": \"RESOLVED\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id/state",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id",
"state"
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"error_tracking_issue\",\n \"attributes\": {\n \"state\": \"RESOLVED\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id/state",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id",
"state"
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update the assignee of an issue",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"87cb11a0-278c-440a-99fe-701223c80296\",\n \"type\": \"assignee\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id/assignee",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id",
"assignee"
],
"variable": [
{
"key": "issue_id",
"value": "c1726a66-1f64-11ee-b338-da7ad0900002"
}
]
},
"description": "Update the assignee of an issue by `issue_id`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"87cb11a0-278c-440a-99fe-701223c80296\",\n \"type\": \"assignee\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id/assignee",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id",
"assignee"
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"c1726a66-1f64-11ee-b338-da7ad0900002\",\n \"type\": \"issue\",\n \"attributes\": {\n \"error_message\": \"object of type 'NoneType' has no len()\",\n \"error_type\": \"builtins.TypeError\",\n \"file_path\": \"/django-email/conduit/apps/core/utils.py\",\n \"first_seen\": 1671612804001,\n \"first_seen_version\": \"aaf65cd0\",\n \"function_name\": \"filter_forbidden_tags\",\n \"is_crash\": false,\n \"languages\": [\n \"PYTHON\",\n \"GO\"\n ],\n \"last_seen\": 1671620003100,\n \"last_seen_version\": \"b6199f80\",\n \"platform\": \"BACKEND\",\n \"service\": \"email-api-py\",\n \"state\": \"RESOLVED\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"87cb11a0-278c-440a-99fe-701223c80296\",\n \"type\": \"user\"\n }\n },\n \"case\": {\n \"data\": {\n \"id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"case\"\n }\n },\n \"team_owners\": {\n \"data\": [\n {\n \"id\": \"221b0179-6447-4d03-91c3-3ca98bf60e8a\",\n \"type\": \"team\"\n },\n {\n \"id\": \"221b0179-6447-4d03-91c3-3ca98bf60e8a\",\n \"type\": \"team\"\n }\n ]\n }\n }\n },\n \"included\": [\n {\n \"id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2025-01-01T00:00:00Z\",\n \"closed_at\": \"2025-01-01T00:00:00Z\",\n \"created_at\": \"2025-01-01T00:00:00Z\",\n \"creation_source\": \"ERROR_TRACKING\",\n \"description\": \"elit minim\",\n \"due_date\": \"2025-01-01\",\n \"insights\": [\n {\n \"ref\": \"/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"resource_id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"ERROR_TRACKING\"\n },\n {\n \"ref\": \"/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"resource_id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"ERROR_TRACKING\"\n }\n ],\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"1904866\",\n \"issue_key\": \"ET-123\",\n \"issue_url\": \"https://your-jira-instance.atlassian.net/browse/ET-123\",\n \"project_key\": \"ET\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"ET-123\",\n \"modified_at\": \"2025-01-01T00:00:00Z\",\n \"priority\": \"NOT_DEFINED\",\n \"status\": \"OPEN\",\n \"title\": \"Error: HTTP error\",\n \"type\": \"ERROR_TRACKING_ISSUE\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n },\n {\n \"id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"case\",\n \"attributes\": {\n \"archived_at\": \"2025-01-01T00:00:00Z\",\n \"closed_at\": \"2025-01-01T00:00:00Z\",\n \"created_at\": \"2025-01-01T00:00:00Z\",\n \"creation_source\": \"ERROR_TRACKING\",\n \"description\": \"commodo\",\n \"due_date\": \"2025-01-01\",\n \"insights\": [\n {\n \"ref\": \"/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"resource_id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"ERROR_TRACKING\"\n },\n {\n \"ref\": \"/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"resource_id\": \"2841440d-e780-4fe2-96cd-6a8c1d194da5\",\n \"type\": \"ERROR_TRACKING\"\n }\n ],\n \"jira_issue\": {\n \"result\": {\n \"issue_id\": \"1904866\",\n \"issue_key\": \"ET-123\",\n \"issue_url\": \"https://your-jira-instance.atlassian.net/browse/ET-123\",\n \"project_key\": \"ET\"\n },\n \"status\": \"COMPLETED\"\n },\n \"key\": \"ET-123\",\n \"modified_at\": \"2025-01-01T00:00:00Z\",\n \"priority\": \"NOT_DEFINED\",\n \"status\": \"OPEN\",\n \"title\": \"Error: HTTP error\",\n \"type\": \"ERROR_TRACKING_ISSUE\"\n },\n \"relationships\": {\n \"assignee\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"user\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"e555e290-ed65-49bd-ae18-8acbfcf18db7\",\n \"type\": \"project\"\n }\n }\n }\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"87cb11a0-278c-440a-99fe-701223c80296\",\n \"type\": \"assignee\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id/assignee",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id",
"assignee"
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"87cb11a0-278c-440a-99fe-701223c80296\",\n \"type\": \"assignee\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id/assignee",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id",
"assignee"
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"87cb11a0-278c-440a-99fe-701223c80296\",\n \"type\": \"assignee\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id/assignee",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id",
"assignee"
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"87cb11a0-278c-440a-99fe-701223c80296\",\n \"type\": \"assignee\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id/assignee",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id",
"assignee"
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"87cb11a0-278c-440a-99fe-701223c80296\",\n \"type\": \"assignee\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/error-tracking/issues/:issue_id/assignee",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"error-tracking",
"issues",
":issue_id",
"assignee"
],
"variable": [
{
"key": "issue_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "View and manage issues within Error Tracking. See the [Error Tracking page](https://docs.datadoghq.com/error_tracking/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Events",
"item": [
{
"name": "Get a list of events",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/events?filter[query]=proident amet voluptate&filter[from]=proident amet voluptate&filter[to]=proident amet voluptate&sort=timestamp&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==&page[limit]=25",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "proident amet voluptate",
"description": "Search query following events syntax."
},
{
"key": "filter[from]",
"value": "proident amet voluptate",
"description": "Minimum timestamp for requested events, in milliseconds."
},
{
"key": "filter[to]",
"value": "proident amet voluptate",
"description": "Maximum timestamp for requested events, in milliseconds."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of events in results."
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response."
}
]
},
"description": "List endpoint returns events that match an events search query.\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to see your latest events."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/events?filter[query]=proident amet voluptate&filter[from]=proident amet voluptate&filter[to]=proident amet voluptate&sort=timestamp&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==&page[limit]=25",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "proident amet voluptate",
"description": "Search query following events syntax."
},
{
"key": "filter[from]",
"value": "proident amet voluptate",
"description": "Minimum timestamp for requested events, in milliseconds."
},
{
"key": "filter[to]",
"value": "proident amet voluptate",
"description": "Maximum timestamp for requested events, in milliseconds."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of events in results."
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"aggregation_key\": \"ullamco officia dolor eiusmod irure\",\n \"date_happened\": 77375346,\n \"device_name\": \"Excepteur irure non\",\n \"duration\": -10543799,\n \"event_object\": \"Did you hear the news today?\",\n \"evt\": {\n \"id\": \"6509751066204996294\",\n \"name\": \"in ut dolore\",\n \"source_id\": 36,\n \"type\": \"error_tracking_alert\"\n },\n \"hostname\": \"anim tempor\",\n \"monitor\": {\n \"created_at\": 1646318692000,\n \"group_status\": 2081290296,\n \"groups\": [\n \"exercitation\",\n \"Duis aliqua\"\n ],\n \"id\": 66532201,\n \"message\": \"dolor adipisicing qui dolor\",\n \"modified\": 62853648,\n \"name\": \"ipsum qui\",\n \"query\": \"esse et dolor\",\n \"tags\": [\n \"environment:test\"\n ],\n \"templated_name\": \"exercitation\",\n \"type\": \"nulla eu aliquip mollit\"\n },\n \"monitor_groups\": [\n \"sint est laborum culpa\",\n \"id aliqua veniam dolor\"\n ],\n \"monitor_id\": -95433065,\n \"priority\": \"normal\",\n \"related_event_id\": 60036812,\n \"service\": \"datadog-api\",\n \"source_type_name\": \"proident Duis consectetur\",\n \"sourcecategory\": \"dolore aute aliquip dolore Ut\",\n \"status\": \"info\",\n \"tags\": [\n \"environment:test\"\n ],\n \"timestamp\": 1652274265000,\n \"title\": \"Oh boy!\"\n },\n \"message\": \"sunt est in\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"event\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"aggregation_key\": \"ex amet non elit fugiat\",\n \"date_happened\": -79597788,\n \"device_name\": \"in qui\",\n \"duration\": -5936887,\n \"event_object\": \"Did you hear the news today?\",\n \"evt\": {\n \"id\": \"6509751066204996294\",\n \"name\": \"non velit proident anim dolor\",\n \"source_id\": 36,\n \"type\": \"error_tracking_alert\"\n },\n \"hostname\": \"fugiat labore dolor in\",\n \"monitor\": {\n \"created_at\": 1646318692000,\n \"group_status\": 381163596,\n \"groups\": [\n \"sed nostrud\",\n \"Lorem\"\n ],\n \"id\": -62559914,\n \"message\": \"mollit ex\",\n \"modified\": 55075784,\n \"name\": \"dolore dolore enim nisi labore\",\n \"query\": \"qui est in id\",\n \"tags\": [\n \"environment:test\"\n ],\n \"templated_name\": \"culpa proident dolore\",\n \"type\": \"ea\"\n },\n \"monitor_groups\": [\n \"adipisicing esse minim ea\",\n \"aliqu\"\n ],\n \"monitor_id\": 87418280,\n \"priority\": \"normal\",\n \"related_event_id\": -25120502,\n \"service\": \"datadog-api\",\n \"source_type_name\": \"veniam\",\n \"sourcecategory\": \"dolor pariatur commodo eu\",\n \"status\": \"info\",\n \"tags\": [\n \"environment:test\"\n ],\n \"timestamp\": 1652274265000,\n \"title\": \"Oh boy!\"\n },\n \"message\": \"ipsum consectetur nostrud Excepteur\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"event\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid. Results hold data from the other indexes.\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid. Results hold data from the other indexes.\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/events?filter[query]=proident amet voluptate&filter[from]=proident amet voluptate&filter[to]=proident amet voluptate&sort=timestamp&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==&page[limit]=25",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "proident amet voluptate",
"description": "Search query following events syntax."
},
{
"key": "filter[from]",
"value": "proident amet voluptate",
"description": "Minimum timestamp for requested events, in milliseconds."
},
{
"key": "filter[to]",
"value": "proident amet voluptate",
"description": "Maximum timestamp for requested events, in milliseconds."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of events in results."
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/events?filter[query]=proident amet voluptate&filter[from]=proident amet voluptate&filter[to]=proident amet voluptate&sort=timestamp&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==&page[limit]=25",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "proident amet voluptate",
"description": "Search query following events syntax."
},
{
"key": "filter[from]",
"value": "proident amet voluptate",
"description": "Minimum timestamp for requested events, in milliseconds."
},
{
"key": "filter[to]",
"value": "proident amet voluptate",
"description": "Maximum timestamp for requested events, in milliseconds."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of events in results."
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/events?filter[query]=proident amet voluptate&filter[from]=proident amet voluptate&filter[to]=proident amet voluptate&sort=timestamp&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==&page[limit]=25",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "proident amet voluptate",
"description": "Search query following events syntax."
},
{
"key": "filter[from]",
"value": "proident amet voluptate",
"description": "Minimum timestamp for requested events, in milliseconds."
},
{
"key": "filter[to]",
"value": "proident amet voluptate",
"description": "Maximum timestamp for requested events, in milliseconds."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of events in results."
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Post an event",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"Did you hear the news today?\",\n \"text\": \"Oh boy!\",\n \"aggregation_key\": \"et e\",\n \"alert_type\": \"info\",\n \"date_happened\": 36581729,\n \"device_name\": \"ex\",\n \"host\": \"do est\",\n \"priority\": \"normal\",\n \"related_event_id\": 29886010,\n \"source_type_name\": \"cil\",\n \"tags\": [\n \"environment:test\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"events"
]
},
"description": "This endpoint allows you to post events to the stream.\nTag them, set priority and event aggregate them with other events."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"Did you hear the news today?\",\n \"text\": \"Oh boy!\",\n \"aggregation_key\": \"et e\",\n \"alert_type\": \"info\",\n \"date_happened\": 36581729,\n \"device_name\": \"ex\",\n \"host\": \"do est\",\n \"priority\": \"normal\",\n \"related_event_id\": 29886010,\n \"source_type_name\": \"cil\",\n \"tags\": [\n \"environment:test\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"events"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"event\": {\n \"alert_type\": \"info\",\n \"date_happened\": 75299812,\n \"device_name\": \"tempor qui\",\n \"host\": \"esse Excepteur\",\n \"id\": 48520700,\n \"id_str\": \"in esse\",\n \"payload\": \"{}\",\n \"priority\": \"normal\",\n \"source_type_name\": \"officia est nisi\",\n \"tags\": [\n \"environment:test\"\n ],\n \"text\": \"Oh boy!\",\n \"title\": \"Did you hear the news today?\",\n \"url\": \"adipisicing proident elit\"\n },\n \"status\": \"mollit amet\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"Did you hear the news today?\",\n \"text\": \"Oh boy!\",\n \"aggregation_key\": \"et e\",\n \"alert_type\": \"info\",\n \"date_happened\": 36581729,\n \"device_name\": \"ex\",\n \"host\": \"do est\",\n \"priority\": \"normal\",\n \"related_event_id\": 29886010,\n \"source_type_name\": \"cil\",\n \"tags\": [\n \"environment:test\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"events"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"Did you hear the news today?\",\n \"text\": \"Oh boy!\",\n \"aggregation_key\": \"et e\",\n \"alert_type\": \"info\",\n \"date_happened\": 36581729,\n \"device_name\": \"ex\",\n \"host\": \"do est\",\n \"priority\": \"normal\",\n \"related_event_id\": 29886010,\n \"source_type_name\": \"cil\",\n \"tags\": [\n \"environment:test\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"events"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get an event",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/events/:event_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events",
":event_id"
],
"variable": [
{
"key": "event_id",
"value": "proident amet voluptate"
}
]
},
"description": "Get the details of an event by `event_id`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/events/:event_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events",
":event_id"
],
"variable": [
{
"key": "event_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"attributes\": {\n \"aggregation_key\": \"aggregation-key\",\n \"author\": {\n \"name\": \"example@datadog.com\",\n \"type\": \"user\"\n },\n \"change_metadata\": {\n \"dd\": {\n \"team\": \"datadog_team\",\n \"user_email\": \"datadog@datadog.com\",\n \"user_id\": \"datadog_user_id\",\n \"user_name\": \"datadog_username\"\n }\n },\n \"changed_resource\": {\n \"name\": \"ex exer\",\n \"type\": \"feature_flag\"\n },\n \"evt\": {\n \"category\": \"change\",\n \"id\": \"id tempor\",\n \"integration_id\": \"custom-events\",\n \"source_id\": -57816040,\n \"uid\": \"officia veniam incidid\"\n },\n \"impacted_resources\": [\n {\n \"name\": \"service-name\",\n \"type\": \"service\"\n }\n ],\n \"new_value\": {\n \"enabled\": true,\n \"percentage\": \"50%\",\n \"rule\": {\n \"datacenter\": \"devcycle.us1.prod\"\n }\n },\n \"prev_value\": {\n \"enabled\": true,\n \"percentage\": \"10%\",\n \"rule\": {\n \"datacenter\": \"devcycle.us1.prod\"\n }\n },\n \"service\": \"service-name\",\n \"timestamp\": 175019386627,\n \"title\": \"The event title\"\n },\n \"message\": \"The event message\",\n \"tags\": [\n \"env:api_client_test\"\n ],\n \"timestamp\": \"2017-01-15T01:30:15.010000Z\"\n },\n \"id\": \"\",\n \"type\": \"event\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/events/:event_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events",
":event_id"
],
"variable": [
{
"key": "event_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/events/:event_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events",
":event_id"
],
"variable": [
{
"key": "event_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/events/:event_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events",
":event_id"
],
"variable": [
{
"key": "event_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/events/:event_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events",
":event_id"
],
"variable": [
{
"key": "event_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/events/:event_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events",
":event_id"
],
"variable": [
{
"key": "event_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Search events",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": -8854962,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events",
"search"
]
},
"description": "List endpoint returns events that match an events search query.\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to build complex events filtering and search."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": -8854962,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events",
"search"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"aggregation_key\": \"ullamco officia dolor eiusmod irure\",\n \"date_happened\": 77375346,\n \"device_name\": \"Excepteur irure non\",\n \"duration\": -10543799,\n \"event_object\": \"Did you hear the news today?\",\n \"evt\": {\n \"id\": \"6509751066204996294\",\n \"name\": \"in ut dolore\",\n \"source_id\": 36,\n \"type\": \"error_tracking_alert\"\n },\n \"hostname\": \"anim tempor\",\n \"monitor\": {\n \"created_at\": 1646318692000,\n \"group_status\": 2081290296,\n \"groups\": [\n \"exercitation\",\n \"Duis aliqua\"\n ],\n \"id\": 66532201,\n \"message\": \"dolor adipisicing qui dolor\",\n \"modified\": 62853648,\n \"name\": \"ipsum qui\",\n \"query\": \"esse et dolor\",\n \"tags\": [\n \"environment:test\"\n ],\n \"templated_name\": \"exercitation\",\n \"type\": \"nulla eu aliquip mollit\"\n },\n \"monitor_groups\": [\n \"sint est laborum culpa\",\n \"id aliqua veniam dolor\"\n ],\n \"monitor_id\": -95433065,\n \"priority\": \"normal\",\n \"related_event_id\": 60036812,\n \"service\": \"datadog-api\",\n \"source_type_name\": \"proident Duis consectetur\",\n \"sourcecategory\": \"dolore aute aliquip dolore Ut\",\n \"status\": \"info\",\n \"tags\": [\n \"environment:test\"\n ],\n \"timestamp\": 1652274265000,\n \"title\": \"Oh boy!\"\n },\n \"message\": \"sunt est in\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"event\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"aggregation_key\": \"ex amet non elit fugiat\",\n \"date_happened\": -79597788,\n \"device_name\": \"in qui\",\n \"duration\": -5936887,\n \"event_object\": \"Did you hear the news today?\",\n \"evt\": {\n \"id\": \"6509751066204996294\",\n \"name\": \"non velit proident anim dolor\",\n \"source_id\": 36,\n \"type\": \"error_tracking_alert\"\n },\n \"hostname\": \"fugiat labore dolor in\",\n \"monitor\": {\n \"created_at\": 1646318692000,\n \"group_status\": 381163596,\n \"groups\": [\n \"sed nostrud\",\n \"Lorem\"\n ],\n \"id\": -62559914,\n \"message\": \"mollit ex\",\n \"modified\": 55075784,\n \"name\": \"dolore dolore enim nisi labore\",\n \"query\": \"qui est in id\",\n \"tags\": [\n \"environment:test\"\n ],\n \"templated_name\": \"culpa proident dolore\",\n \"type\": \"ea\"\n },\n \"monitor_groups\": [\n \"adipisicing esse minim ea\",\n \"aliqu\"\n ],\n \"monitor_id\": 87418280,\n \"priority\": \"normal\",\n \"related_event_id\": -25120502,\n \"service\": \"datadog-api\",\n \"source_type_name\": \"veniam\",\n \"sourcecategory\": \"dolor pariatur commodo eu\",\n \"status\": \"info\",\n \"tags\": [\n \"environment:test\"\n ],\n \"timestamp\": 1652274265000,\n \"title\": \"Oh boy!\"\n },\n \"message\": \"ipsum consectetur nostrud Excepteur\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"event\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid. Results hold data from the other indexes.\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid. Results hold data from the other indexes.\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": -8854962,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events",
"search"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": -8854962,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events",
"search"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": -8854962,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"events",
"search"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "The Event Management API allows you to programmatically post events to the Events Explorer and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/) for more information.\n\n**Update to Datadog monitor events `aggregation_key` starting March 1, 2025:** The Datadog monitor events `aggregation_key` is unique to each Monitor ID. Starting March 1st, this key will also include Monitor Group, making it unique per *Monitor ID and Monitor Group*. If you're using monitor events `aggregation_key` in dashboard queries or the Event API, you must migrate to use `@monitor.id`. Reach out to [support](https://www.datadoghq.com/support/) if you have any question.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Fastly Integration",
"item": [
{
"name": "List Fastly accounts",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts"
]
},
"description": "List Fastly accounts."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"name\": \"test-name\",\n \"services\": [\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ]\n },\n \"id\": \"abc123\",\n \"type\": \"fastly-accounts\"\n },\n {\n \"attributes\": {\n \"name\": \"test-name\",\n \"services\": [\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ]\n },\n \"id\": \"abc123\",\n \"type\": \"fastly-accounts\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Add Fastly account",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"ABCDEFG123\",\n \"name\": \"test-name\",\n \"services\": [\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ]\n },\n \"type\": \"fastly-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts"
]
},
"description": "Create a Fastly account."
},
"response": [
{
"name": "CREATED",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"ABCDEFG123\",\n \"name\": \"test-name\",\n \"services\": [\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ]\n },\n \"type\": \"fastly-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"test-name\",\n \"services\": [\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ]\n },\n \"id\": \"abc123\",\n \"type\": \"fastly-accounts\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"ABCDEFG123\",\n \"name\": \"test-name\",\n \"services\": [\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ]\n },\n \"type\": \"fastly-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"ABCDEFG123\",\n \"name\": \"test-name\",\n \"services\": [\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ]\n },\n \"type\": \"fastly-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"ABCDEFG123\",\n \"name\": \"test-name\",\n \"services\": [\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ]\n },\n \"type\": \"fastly-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"ABCDEFG123\",\n \"name\": \"test-name\",\n \"services\": [\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ]\n },\n \"type\": \"fastly-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get Fastly account",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Get a Fastly account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"test-name\",\n \"services\": [\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ]\n },\n \"id\": \"abc123\",\n \"type\": \"fastly-accounts\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update Fastly account",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"ABCDEFG123\"\n },\n \"type\": \"fastly-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Update a Fastly account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"ABCDEFG123\"\n },\n \"type\": \"fastly-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"test-name\",\n \"services\": [\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n },\n {\n \"id\": \"6abc7de6893AbcDe9fghIj\",\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n ]\n },\n \"id\": \"abc123\",\n \"type\": \"fastly-accounts\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"ABCDEFG123\"\n },\n \"type\": \"fastly-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"ABCDEFG123\"\n },\n \"type\": \"fastly-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"ABCDEFG123\"\n },\n \"type\": \"fastly-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"api_key\": \"ABCDEFG123\"\n },\n \"type\": \"fastly-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete Fastly account",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete a Fastly account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List Fastly services",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "List Fastly services for an account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n },\n {\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Add Fastly service",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Create a Fastly service for an account."
},
"response": [
{
"name": "CREATED",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get Fastly service",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
},
{
"key": "service_id",
"value": "pariatur consequat"
}
]
},
"description": "Get a Fastly service for an account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "service_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "service_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "service_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "service_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "service_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update Fastly service",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
},
{
"key": "service_id",
"value": "pariatur consequat"
}
]
},
"description": "Update a Fastly service for an account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "service_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "service_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "service_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "service_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"fastly-services\",\n \"attributes\": {\n \"tags\": [\n \"myTag\",\n \"myTag2:myValue\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "service_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete Fastly service",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
},
{
"key": "service_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete a Fastly service for an account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "service_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "service_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "service_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "service_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"fastly",
"accounts",
":account_id",
"services",
":service_id"
],
"variable": [
{
"key": "account_id"
},
{
"key": "service_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Manage your Datadog Fastly integration accounts and services directly through the Datadog API. See the [Fastly integration page](https://docs.datadoghq.com/integrations/fastly/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "GCP Integration",
"item": [
{
"name": "List all GCP STS-enabled service accounts",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts"
]
},
"description": "List all GCP STS-enabled service accounts configured in your Datadog account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"account_tags\": [\n \"magna ullamco culpa dolore sunt\",\n \"tempor\"\n ],\n \"automute\": false,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"eu dolore\",\n \"qui enim\"\n ],\n \"is_cspm_enabled\": false,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": false\n },\n \"id\": \"d291291f-12c2-22g4-j290-123456678897\",\n \"meta\": {\n \"accessible_projects\": [\n \"pariatur\",\n \"incididu\"\n ]\n },\n \"type\": \"gcp_service_account\"\n },\n {\n \"attributes\": {\n \"account_tags\": [\n \"in consectet\",\n \"amet Lorem est do\"\n ],\n \"automute\": true,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"et velit aut\",\n \"reprehenderit eiusmod ut\"\n ],\n \"is_cspm_enabled\": false,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": false\n },\n \"id\": \"d291291f-12c2-22g4-j290-123456678897\",\n \"meta\": {\n \"accessible_projects\": [\n \"culpa Ut incididunt ad\",\n \"dolor sed ut consectetur do\"\n ]\n },\n \"type\": \"gcp_service_account\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a new entry for your service account",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_tags\": [\n \"laborum elit irure anim nisi\",\n \"voluptate fugiat\"\n ],\n \"automute\": false,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"ut\",\n \"non n\"\n ],\n \"is_cspm_enabled\": false,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": false\n },\n \"type\": \"gcp_service_account\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts"
]
},
"description": "Create a new entry within Datadog for your STS enabled service account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_tags\": [\n \"laborum elit irure anim nisi\",\n \"voluptate fugiat\"\n ],\n \"automute\": false,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"ut\",\n \"non n\"\n ],\n \"is_cspm_enabled\": false,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": false\n },\n \"type\": \"gcp_service_account\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"account_tags\": [\n \"Lorem laboris fugiat\",\n \"dolor ea proident\"\n ],\n \"automute\": true,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"cillum \",\n \"ut\"\n ],\n \"is_cspm_enabled\": true,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": false\n },\n \"id\": \"d291291f-12c2-22g4-j290-123456678897\",\n \"meta\": {\n \"accessible_projects\": [\n \"dolor \",\n \"Duis\"\n ]\n },\n \"type\": \"gcp_service_account\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_tags\": [\n \"laborum elit irure anim nisi\",\n \"voluptate fugiat\"\n ],\n \"automute\": false,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"ut\",\n \"non n\"\n ],\n \"is_cspm_enabled\": false,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": false\n },\n \"type\": \"gcp_service_account\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_tags\": [\n \"laborum elit irure anim nisi\",\n \"voluptate fugiat\"\n ],\n \"automute\": false,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"ut\",\n \"non n\"\n ],\n \"is_cspm_enabled\": false,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": false\n },\n \"type\": \"gcp_service_account\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_tags\": [\n \"laborum elit irure anim nisi\",\n \"voluptate fugiat\"\n ],\n \"automute\": false,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"ut\",\n \"non n\"\n ],\n \"is_cspm_enabled\": false,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": false\n },\n \"type\": \"gcp_service_account\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_tags\": [\n \"laborum elit irure anim nisi\",\n \"voluptate fugiat\"\n ],\n \"automute\": false,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"ut\",\n \"non n\"\n ],\n \"is_cspm_enabled\": false,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": false\n },\n \"type\": \"gcp_service_account\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_tags\": [\n \"laborum elit irure anim nisi\",\n \"voluptate fugiat\"\n ],\n \"automute\": false,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"ut\",\n \"non n\"\n ],\n \"is_cspm_enabled\": false,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": false\n },\n \"type\": \"gcp_service_account\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete an STS enabled GCP Account",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete an STS enabled GCP account from within Datadog."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update STS Service Account",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_tags\": [\n \"cillum ea dolor tempor\",\n \"in nulla Duis\"\n ],\n \"automute\": false,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"qui\",\n \"in ipsum veniam\"\n ],\n \"is_cspm_enabled\": true,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": true\n },\n \"id\": \"d291291f-12c2-22g4-j290-123456678897\",\n \"type\": \"gcp_service_account\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Update an STS enabled service account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_tags\": [\n \"cillum ea dolor tempor\",\n \"in nulla Duis\"\n ],\n \"automute\": false,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"qui\",\n \"in ipsum veniam\"\n ],\n \"is_cspm_enabled\": true,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": true\n },\n \"id\": \"d291291f-12c2-22g4-j290-123456678897\",\n \"type\": \"gcp_service_account\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"account_tags\": [\n \"Lorem laboris fugiat\",\n \"dolor ea proident\"\n ],\n \"automute\": true,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"cillum \",\n \"ut\"\n ],\n \"is_cspm_enabled\": true,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": false\n },\n \"id\": \"d291291f-12c2-22g4-j290-123456678897\",\n \"meta\": {\n \"accessible_projects\": [\n \"dolor \",\n \"Duis\"\n ]\n },\n \"type\": \"gcp_service_account\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_tags\": [\n \"cillum ea dolor tempor\",\n \"in nulla Duis\"\n ],\n \"automute\": false,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"qui\",\n \"in ipsum veniam\"\n ],\n \"is_cspm_enabled\": true,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": true\n },\n \"id\": \"d291291f-12c2-22g4-j290-123456678897\",\n \"type\": \"gcp_service_account\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_tags\": [\n \"cillum ea dolor tempor\",\n \"in nulla Duis\"\n ],\n \"automute\": false,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"qui\",\n \"in ipsum veniam\"\n ],\n \"is_cspm_enabled\": true,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": true\n },\n \"id\": \"d291291f-12c2-22g4-j290-123456678897\",\n \"type\": \"gcp_service_account\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_tags\": [\n \"cillum ea dolor tempor\",\n \"in nulla Duis\"\n ],\n \"automute\": false,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"qui\",\n \"in ipsum veniam\"\n ],\n \"is_cspm_enabled\": true,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": true\n },\n \"id\": \"d291291f-12c2-22g4-j290-123456678897\",\n \"type\": \"gcp_service_account\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"account_tags\": [\n \"cillum ea dolor tempor\",\n \"in nulla Duis\"\n ],\n \"automute\": false,\n \"client_email\": \"datadog-service-account@test-project.iam.gserviceaccount.com\",\n \"cloud_run_revision_filters\": [\n \"$KEY:$VALUE\"\n ],\n \"host_filters\": [\n \"qui\",\n \"in ipsum veniam\"\n ],\n \"is_cspm_enabled\": true,\n \"is_security_command_center_enabled\": true,\n \"resource_collection_enabled\": true\n },\n \"id\": \"d291291f-12c2-22g4-j290-123456678897\",\n \"type\": \"gcp_service_account\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a Datadog GCP principal",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/sts_delegate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"sts_delegate"
]
},
"description": "Create a Datadog GCP principal."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/sts_delegate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"sts_delegate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"delegate_account_email\": \"ddgci-1a19n28hb1a812221893@datadog-gci-sts-us5-prod.iam.gserviceaccount.com\"\n },\n \"id\": \"ddgci-1a19n28hb1a812221893@datadog-gci-sts-us5-prod.iam.gserviceaccount.com\",\n \"type\": \"gcp_sts_delegate\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/sts_delegate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"sts_delegate"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/sts_delegate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"sts_delegate"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/sts_delegate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"sts_delegate"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List delegate account",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/sts_delegate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"sts_delegate"
]
},
"description": "List your Datadog-GCP STS delegate account configured in your Datadog account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/sts_delegate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"sts_delegate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"delegate_account_email\": \"ddgci-1a19n28hb1a812221893@datadog-gci-sts-us5-prod.iam.gserviceaccount.com\"\n },\n \"id\": \"ddgci-1a19n28hb1a812221893@datadog-gci-sts-us5-prod.iam.gserviceaccount.com\",\n \"type\": \"gcp_sts_delegate\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/sts_delegate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"sts_delegate"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/gcp/sts_delegate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"gcp",
"sts_delegate"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Configure your Datadog-Google Cloud Platform (GCP) integration directly\nthrough the Datadog API. Read more about the [Datadog-Google Cloud Platform integration](https://docs.datadoghq.com/integrations/google_cloud_platform).",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Hosts",
"item": [
{
"name": "Get all hosts for your organization",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/hosts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"hosts"
],
"query": [
{
"key": "filter",
"value": "pariatur",
"description": "String to filter search results.",
"disabled": true
},
{
"key": "sort_field",
"value": "pariatur",
"description": "Sort hosts by this field.",
"disabled": true
},
{
"key": "sort_dir",
"value": "pariatur",
"description": "Direction of sort. Options include `asc` and `desc`.",
"disabled": true
},
{
"key": "start",
"value": "-32260706",
"description": "Host result to start search from.",
"disabled": true
},
{
"key": "count",
"value": "-32260706",
"description": "Number of hosts to return. Max 1000.",
"disabled": true
},
{
"key": "from",
"value": "-32260706",
"description": "Number of seconds since UNIX epoch from which you want to search your hosts.",
"disabled": true
},
{
"key": "include_muted_hosts_data",
"value": "true",
"description": "Include information on the muted status of hosts and when the mute expires.",
"disabled": true
},
{
"key": "include_hosts_metadata",
"value": "true",
"description": "Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.).",
"disabled": true
}
]
},
"description": "This endpoint allows searching for hosts by name, alias, or tag.\nHosts live within the past 3 hours are included by default.\nRetention is 7 days.\nResults are paginated with a max of 1000 results at a time."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/hosts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"hosts"
],
"query": [
{
"key": "filter",
"value": "pariatur",
"description": "String to filter search results.",
"disabled": true
},
{
"key": "sort_field",
"value": "pariatur",
"description": "Sort hosts by this field.",
"disabled": true
},
{
"key": "sort_dir",
"value": "pariatur",
"description": "Direction of sort. Options include `asc` and `desc`.",
"disabled": true
},
{
"key": "start",
"value": "-32260706",
"description": "Host result to start search from.",
"disabled": true
},
{
"key": "count",
"value": "-32260706",
"description": "Number of hosts to return. Max 1000.",
"disabled": true
},
{
"key": "from",
"value": "-32260706",
"description": "Number of seconds since UNIX epoch from which you want to search your hosts.",
"disabled": true
},
{
"key": "include_muted_hosts_data",
"value": "true",
"description": "Include information on the muted status of hosts and when the mute expires.",
"disabled": true
},
{
"key": "include_hosts_metadata",
"value": "true",
"description": "Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.).",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"host_list\": [\n {\n \"aliases\": [\n \"mycoolhost-1\",\n \"mycoolhost-1\"\n ],\n \"apps\": [\n \"agent\",\n \"agent\"\n ],\n \"aws_name\": \"mycoolhost-1\",\n \"host_name\": \"i-deadbeef\",\n \"id\": 123456,\n \"is_muted\": false,\n \"last_reported_time\": 1565000000,\n \"meta\": {\n \"agent_checks\": [\n [\n \"ntp\",\n \"ntp\",\n \"ntp:d884b5186b651429\",\n \"OK\",\n \"\",\n \"\"\n ],\n [\n \"ntp\",\n \"ntp\",\n \"ntp:d884b5186b651429\",\n \"OK\",\n \"\",\n \"\"\n ]\n ],\n \"agent_version\": \"7.32.3\",\n \"cpuCores\": 1,\n \"fbsdV\": [\n \"FreeBSD\",\n \"FreeBSD\"\n ],\n \"gohai\": \"{\\\"cpu\\\":{\\\"cache_size\\\":\\\"8192 KB\\\",\\\"cpu_cores\\\":\\\"1\\\",\\\"cpu_logical_processors\\\":\\\"1\\\",\\\"family\\\":\\\"6\\\",\\\"mhz\\\":\\\"2712.000\\\",\\\"model\\\":\\\"142\\\",\\\"model_name\\\":\\\"Intel(R) Core(TM) i7-8559U CPU @ 2.70GHz\\\",\\\"stepping\\\":\\\"10\\\",\\\"vendor_id\\\":\\\"GenuineIntel\\\"},\\\"filesystem\\\":[{\\\"kb_size\\\":\\\"3966896\\\",\\\"mounted_on\\\":\\\"/dev\\\",\\\"name\\\":\\\"udev\\\"},{\\\"kb_size\\\":\\\"797396\\\",\\\"mounted_on\\\":\\\"/run\\\",\\\"name\\\":\\\"tmpfs\\\"},{\\\"kb_size\\\":\\\"64800356\\\",\\\"mounted_on\\\":\\\"/\\\",\\\"name\\\":\\\"/dev/mapper/vagrant--vg-root\\\"},{\\\"kb_size\\\":\\\"3986972\\\",\\\"mounted_on\\\":\\\"/dev/shm\\\",\\\"name\\\":\\\"tmpfs\\\"},{\\\"kb_size\\\":\\\"5120\\\",\\\"mounted_on\\\":\\\"/run/lock\\\",\\\"name\\\":\\\"tmpfs\\\"},{\\\"kb_size\\\":\\\"3986972\\\",\\\"mounted_on\\\":\\\"/sys/fs/cgroup\\\",\\\"name\\\":\\\"tmpfs\\\"},{\\\"kb_size\\\":\\\"488245288\\\",\\\"mounted_on\\\":\\\"/vagrant\\\",\\\"name\\\":\\\"vagrant\\\"},{\\\"kb_size\\\":\\\"797392\\\",\\\"mounted_on\\\":\\\"/run/user/1000\\\",\\\"name\\\":\\\"tmpfs\\\"}],\\\"memory\\\":{\\\"swap_total\\\":\\\"1003516kB\\\",\\\"total\\\":\\\"7973944kB\\\"},\\\"network\\\":{\\\"interfaces\\\":[{\\\"ipv4\\\":\\\"10.0.2.15\\\",\\\"ipv4-network\\\":\\\"10.0.2.0/24\\\",\\\"ipv6\\\":\\\"fe80::a00:27ff:fec2:be11\\\",\\\"ipv6-network\\\":\\\"fe80::/64\\\",\\\"macaddress\\\":\\\"08:00:27:c2:be:11\\\",\\\"name\\\":\\\"eth0\\\"},{\\\"ipv4\\\":\\\"192.168.122.1\\\",\\\"ipv4-network\\\":\\\"192.168.122.0/24\\\",\\\"macaddress\\\":\\\"52:54:00:6f:1c:bf\\\",\\\"name\\\":\\\"virbr0\\\"}],\\\"ipaddress\\\":\\\"10.0.2.15\\\",\\\"ipaddressv6\\\":\\\"fe80::a00:27ff:fec2:be11\\\",\\\"macaddress\\\":\\\"08:00:27:c2:be:11\\\"},\\\"platform\\\":{\\\"GOOARCH\\\":\\\"amd64\\\",\\\"GOOS\\\":\\\"linux\\\",\\\"goV\\\":\\\"1.16.7\\\",\\\"hardware_platform\\\":\\\"x86_64\\\",\\\"hostname\\\":\\\"vagrant\\\",\\\"kernel_name\\\":\\\"Linux\\\",\\\"kernel_release\\\":\\\"4.15.0-29-generic\\\",\\\"kernel_version\\\":\\\"#31-Ubuntu SMP Tue Jul 17 15:39:52 UTC 2018\\\",\\\"machine\\\":\\\"x86_64\\\",\\\"os\\\":\\\"GNU/Linux\\\",\\\"processor\\\":\\\"x86_64\\\",\\\"pythonV\\\":\\\"2.7.15rc1\\\"}}\",\n \"install_method\": {\n \"installer_version\": \"install_script-1.7.1\",\n \"tool\": \"install_script\",\n \"tool_version\": \"install_script\"\n },\n \"macV\": [\n \"Mac\",\n \"Mac\"\n ],\n \"machine\": \"amd64\",\n \"nixV\": [\n \"Ubuntu\",\n \"Ubuntu\"\n ],\n \"platform\": \"linux\",\n \"processor\": \"Intel(R) Core(TM) i7-8559U CPU @ 2.70GHz\",\n \"pythonV\": \"3.8.11\",\n \"socket-fqdn\": \"vagrant.vm.\",\n \"socket-hostname\": \"vagrant\",\n \"winV\": [\n \"Windows\",\n \"Windows\"\n ]\n },\n \"metrics\": {\n \"cpu\": 99,\n \"iowait\": 3.2,\n \"load\": 0.5\n },\n \"mute_timeout\": 64695743,\n \"name\": \"i-hostname\",\n \"sources\": [\n \"aws\",\n \"aws\"\n ],\n \"tags_by_source\": {\n \"dolorecdc\": [\n \"test.example.com.host\",\n \"test.example.com.host\"\n ],\n \"ut_1c\": [\n \"test.example.com.host\",\n \"test.example.com.host\"\n ],\n \"aliqua_4\": [\n \"test.example.com.host\",\n \"test.example.com.host\"\n ]\n },\n \"up\": true\n },\n {\n \"aliases\": [\n \"mycoolhost-1\",\n \"mycoolhost-1\"\n ],\n \"apps\": [\n \"agent\",\n \"agent\"\n ],\n \"aws_name\": \"mycoolhost-1\",\n \"host_name\": \"i-deadbeef\",\n \"id\": 123456,\n \"is_muted\": false,\n \"last_reported_time\": 1565000000,\n \"meta\": {\n \"agent_checks\": [\n [\n \"ntp\",\n \"ntp\",\n \"ntp:d884b5186b651429\",\n \"OK\",\n \"\",\n \"\"\n ],\n [\n \"ntp\",\n \"ntp\",\n \"ntp:d884b5186b651429\",\n \"OK\",\n \"\",\n \"\"\n ]\n ],\n \"agent_version\": \"7.32.3\",\n \"cpuCores\": 1,\n \"fbsdV\": [\n \"FreeBSD\",\n \"FreeBSD\"\n ],\n \"gohai\": \"{\\\"cpu\\\":{\\\"cache_size\\\":\\\"8192 KB\\\",\\\"cpu_cores\\\":\\\"1\\\",\\\"cpu_logical_processors\\\":\\\"1\\\",\\\"family\\\":\\\"6\\\",\\\"mhz\\\":\\\"2712.000\\\",\\\"model\\\":\\\"142\\\",\\\"model_name\\\":\\\"Intel(R) Core(TM) i7-8559U CPU @ 2.70GHz\\\",\\\"stepping\\\":\\\"10\\\",\\\"vendor_id\\\":\\\"GenuineIntel\\\"},\\\"filesystem\\\":[{\\\"kb_size\\\":\\\"3966896\\\",\\\"mounted_on\\\":\\\"/dev\\\",\\\"name\\\":\\\"udev\\\"},{\\\"kb_size\\\":\\\"797396\\\",\\\"mounted_on\\\":\\\"/run\\\",\\\"name\\\":\\\"tmpfs\\\"},{\\\"kb_size\\\":\\\"64800356\\\",\\\"mounted_on\\\":\\\"/\\\",\\\"name\\\":\\\"/dev/mapper/vagrant--vg-root\\\"},{\\\"kb_size\\\":\\\"3986972\\\",\\\"mounted_on\\\":\\\"/dev/shm\\\",\\\"name\\\":\\\"tmpfs\\\"},{\\\"kb_size\\\":\\\"5120\\\",\\\"mounted_on\\\":\\\"/run/lock\\\",\\\"name\\\":\\\"tmpfs\\\"},{\\\"kb_size\\\":\\\"3986972\\\",\\\"mounted_on\\\":\\\"/sys/fs/cgroup\\\",\\\"name\\\":\\\"tmpfs\\\"},{\\\"kb_size\\\":\\\"488245288\\\",\\\"mounted_on\\\":\\\"/vagrant\\\",\\\"name\\\":\\\"vagrant\\\"},{\\\"kb_size\\\":\\\"797392\\\",\\\"mounted_on\\\":\\\"/run/user/1000\\\",\\\"name\\\":\\\"tmpfs\\\"}],\\\"memory\\\":{\\\"swap_total\\\":\\\"1003516kB\\\",\\\"total\\\":\\\"7973944kB\\\"},\\\"network\\\":{\\\"interfaces\\\":[{\\\"ipv4\\\":\\\"10.0.2.15\\\",\\\"ipv4-network\\\":\\\"10.0.2.0/24\\\",\\\"ipv6\\\":\\\"fe80::a00:27ff:fec2:be11\\\",\\\"ipv6-network\\\":\\\"fe80::/64\\\",\\\"macaddress\\\":\\\"08:00:27:c2:be:11\\\",\\\"name\\\":\\\"eth0\\\"},{\\\"ipv4\\\":\\\"192.168.122.1\\\",\\\"ipv4-network\\\":\\\"192.168.122.0/24\\\",\\\"macaddress\\\":\\\"52:54:00:6f:1c:bf\\\",\\\"name\\\":\\\"virbr0\\\"}],\\\"ipaddress\\\":\\\"10.0.2.15\\\",\\\"ipaddressv6\\\":\\\"fe80::a00:27ff:fec2:be11\\\",\\\"macaddress\\\":\\\"08:00:27:c2:be:11\\\"},\\\"platform\\\":{\\\"GOOARCH\\\":\\\"amd64\\\",\\\"GOOS\\\":\\\"linux\\\",\\\"goV\\\":\\\"1.16.7\\\",\\\"hardware_platform\\\":\\\"x86_64\\\",\\\"hostname\\\":\\\"vagrant\\\",\\\"kernel_name\\\":\\\"Linux\\\",\\\"kernel_release\\\":\\\"4.15.0-29-generic\\\",\\\"kernel_version\\\":\\\"#31-Ubuntu SMP Tue Jul 17 15:39:52 UTC 2018\\\",\\\"machine\\\":\\\"x86_64\\\",\\\"os\\\":\\\"GNU/Linux\\\",\\\"processor\\\":\\\"x86_64\\\",\\\"pythonV\\\":\\\"2.7.15rc1\\\"}}\",\n \"install_method\": {\n \"installer_version\": \"install_script-1.7.1\",\n \"tool\": \"install_script\",\n \"tool_version\": \"install_script\"\n },\n \"macV\": [\n \"Mac\",\n \"Mac\"\n ],\n \"machine\": \"amd64\",\n \"nixV\": [\n \"Ubuntu\",\n \"Ubuntu\"\n ],\n \"platform\": \"linux\",\n \"processor\": \"Intel(R) Core(TM) i7-8559U CPU @ 2.70GHz\",\n \"pythonV\": \"3.8.11\",\n \"socket-fqdn\": \"vagrant.vm.\",\n \"socket-hostname\": \"vagrant\",\n \"winV\": [\n \"Windows\",\n \"Windows\"\n ]\n },\n \"metrics\": {\n \"cpu\": 99,\n \"iowait\": 3.2,\n \"load\": 0.5\n },\n \"mute_timeout\": 75321571,\n \"name\": \"i-hostname\",\n \"sources\": [\n \"aws\",\n \"aws\"\n ],\n \"tags_by_source\": {\n \"eiusmod_0\": [\n \"test.example.com.host\",\n \"test.example.com.host\"\n ],\n \"dolor_7\": [\n \"test.example.com.host\",\n \"test.example.com.host\"\n ]\n },\n \"up\": true\n }\n ],\n \"total_matching\": 1,\n \"total_returned\": 1\n}"
},
{
"name": "Invalid Parameter Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/hosts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"hosts"
],
"query": [
{
"key": "filter",
"value": "pariatur",
"description": "String to filter search results.",
"disabled": true
},
{
"key": "sort_field",
"value": "pariatur",
"description": "Sort hosts by this field.",
"disabled": true
},
{
"key": "sort_dir",
"value": "pariatur",
"description": "Direction of sort. Options include `asc` and `desc`.",
"disabled": true
},
{
"key": "start",
"value": "-32260706",
"description": "Host result to start search from.",
"disabled": true
},
{
"key": "count",
"value": "-32260706",
"description": "Number of hosts to return. Max 1000.",
"disabled": true
},
{
"key": "from",
"value": "-32260706",
"description": "Number of seconds since UNIX epoch from which you want to search your hosts.",
"disabled": true
},
{
"key": "include_muted_hosts_data",
"value": "true",
"description": "Include information on the muted status of hosts and when the mute expires.",
"disabled": true
},
{
"key": "include_hosts_metadata",
"value": "true",
"description": "Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.).",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/hosts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"hosts"
],
"query": [
{
"key": "filter",
"value": "pariatur",
"description": "String to filter search results.",
"disabled": true
},
{
"key": "sort_field",
"value": "pariatur",
"description": "Sort hosts by this field.",
"disabled": true
},
{
"key": "sort_dir",
"value": "pariatur",
"description": "Direction of sort. Options include `asc` and `desc`.",
"disabled": true
},
{
"key": "start",
"value": "-32260706",
"description": "Host result to start search from.",
"disabled": true
},
{
"key": "count",
"value": "-32260706",
"description": "Number of hosts to return. Max 1000.",
"disabled": true
},
{
"key": "from",
"value": "-32260706",
"description": "Number of seconds since UNIX epoch from which you want to search your hosts.",
"disabled": true
},
{
"key": "include_muted_hosts_data",
"value": "true",
"description": "Include information on the muted status of hosts and when the mute expires.",
"disabled": true
},
{
"key": "include_hosts_metadata",
"value": "true",
"description": "Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.).",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/hosts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"hosts"
],
"query": [
{
"key": "filter",
"value": "pariatur",
"description": "String to filter search results.",
"disabled": true
},
{
"key": "sort_field",
"value": "pariatur",
"description": "Sort hosts by this field.",
"disabled": true
},
{
"key": "sort_dir",
"value": "pariatur",
"description": "Direction of sort. Options include `asc` and `desc`.",
"disabled": true
},
{
"key": "start",
"value": "-32260706",
"description": "Host result to start search from.",
"disabled": true
},
{
"key": "count",
"value": "-32260706",
"description": "Number of hosts to return. Max 1000.",
"disabled": true
},
{
"key": "from",
"value": "-32260706",
"description": "Number of seconds since UNIX epoch from which you want to search your hosts.",
"disabled": true
},
{
"key": "include_muted_hosts_data",
"value": "true",
"description": "Include information on the muted status of hosts and when the mute expires.",
"disabled": true
},
{
"key": "include_hosts_metadata",
"value": "true",
"description": "Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.).",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get the total number of active hosts",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/hosts/totals",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"hosts",
"totals"
],
"query": [
{
"key": "from",
"value": "-32260706",
"description": "Number of seconds from which you want to get total number of active hosts.",
"disabled": true
}
]
},
"description": "This endpoint returns the total number of active and up hosts in your Datadog account.\nActive means the host has reported in the past hour, and up means it has reported in the past two hours."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/hosts/totals",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"hosts",
"totals"
],
"query": [
{
"key": "from",
"value": "-32260706",
"description": "Number of seconds from which you want to get total number of active hosts.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"total_active\": -99519322,\n \"total_up\": -29118149\n}"
},
{
"name": "Invalid Parameter Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/hosts/totals",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"hosts",
"totals"
],
"query": [
{
"key": "from",
"value": "-32260706",
"description": "Number of seconds from which you want to get total number of active hosts.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/hosts/totals",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"hosts",
"totals"
],
"query": [
{
"key": "from",
"value": "-32260706",
"description": "Number of seconds from which you want to get total number of active hosts.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/hosts/totals",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"hosts",
"totals"
],
"query": [
{
"key": "from",
"value": "-32260706",
"description": "Number of seconds from which you want to get total number of active hosts.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Mute a host",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"end\": 1579098130,\n \"message\": \"Muting this host for a test!\",\n \"override\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/host/:host_name/mute",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"host",
":host_name",
"mute"
],
"variable": [
{
"key": "host_name",
"value": "pariatur"
}
]
},
"description": "Mute a host. **Note:** This creates a [Downtime V2](https://docs.datadoghq.com/api/latest/downtimes/#schedule-a-downtime) for the host."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"end\": 1579098130,\n \"message\": \"Muting this host for a test!\",\n \"override\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/host/:host_name/mute",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"host",
":host_name",
"mute"
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"action\": \"Muted\",\n \"end\": 1579098130,\n \"hostname\": \"test.host\",\n \"message\": \"Muting this host for a test!\"\n}"
},
{
"name": "Invalid Parameter Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"end\": 1579098130,\n \"message\": \"Muting this host for a test!\",\n \"override\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/host/:host_name/mute",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"host",
":host_name",
"mute"
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"end\": 1579098130,\n \"message\": \"Muting this host for a test!\",\n \"override\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/host/:host_name/mute",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"host",
":host_name",
"mute"
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"end\": 1579098130,\n \"message\": \"Muting this host for a test!\",\n \"override\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/host/:host_name/mute",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"host",
":host_name",
"mute"
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Unmute a host",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/host/:host_name/unmute",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"host",
":host_name",
"unmute"
],
"variable": [
{
"key": "host_name",
"value": "pariatur"
}
]
},
"description": "Unmutes a host. This endpoint takes no JSON arguments."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/host/:host_name/unmute",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"host",
":host_name",
"unmute"
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"action\": \"Muted\",\n \"end\": 1579098130,\n \"hostname\": \"test.host\",\n \"message\": \"Muting this host for a test!\"\n}"
},
{
"name": "Invalid Parameter Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/host/:host_name/unmute",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"host",
":host_name",
"unmute"
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/host/:host_name/unmute",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"host",
":host_name",
"unmute"
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/host/:host_name/unmute",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"host",
":host_name",
"unmute"
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Get information about your infrastructure hosts in Datadog, and mute or unmute any notifications from your hosts. See the [Infrastructure page](https://docs.datadoghq.com/infrastructure/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "IP Allowlist",
"item": [
{
"name": "Get IP Allowlist",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
},
"description": "Returns the IP allowlist and its enabled or disabled state."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": false,\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"enim laborum\",\n \"created_at\": \"1972-06-07T14:46:34.210Z\",\n \"modified_at\": \"1988-01-07T19:10:13.916Z\",\n \"note\": \"consectetur\"\n },\n \"id\": \"nisi tempor anim\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"elit proident aliqua\",\n \"created_at\": \"1993-08-08T22:37:24.691Z\",\n \"modified_at\": \"1997-01-15T07:09:33.666Z\",\n \"note\": \"sint officia\"\n },\n \"id\": \"dolore enim qui exercitation ni\"\n }\n }\n ]\n },\n \"id\": \"quis amet\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update IP Allowlist",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": true,\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"ex dolor\",\n \"created_at\": \"2009-12-03T11:44:52.134Z\",\n \"modified_at\": \"1959-12-24T16:13:38.278Z\",\n \"note\": \"id elit\"\n },\n \"id\": \"velit consectetur E\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"in eiusmod\",\n \"created_at\": \"1966-12-20T11:32:11.805Z\",\n \"modified_at\": \"2021-08-20T00:58:12.658Z\",\n \"note\": \"ea e\"\n },\n \"id\": \"magna labore\"\n }\n }\n ]\n },\n \"id\": \"elit enim\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
},
"description": "Edit the entries in the IP allowlist, and enable or disable it."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": true,\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"ex dolor\",\n \"created_at\": \"2009-12-03T11:44:52.134Z\",\n \"modified_at\": \"1959-12-24T16:13:38.278Z\",\n \"note\": \"id elit\"\n },\n \"id\": \"velit consectetur E\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"in eiusmod\",\n \"created_at\": \"1966-12-20T11:32:11.805Z\",\n \"modified_at\": \"2021-08-20T00:58:12.658Z\",\n \"note\": \"ea e\"\n },\n \"id\": \"magna labore\"\n }\n }\n ]\n },\n \"id\": \"elit enim\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": false,\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"enim laborum\",\n \"created_at\": \"1972-06-07T14:46:34.210Z\",\n \"modified_at\": \"1988-01-07T19:10:13.916Z\",\n \"note\": \"consectetur\"\n },\n \"id\": \"nisi tempor anim\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"elit proident aliqua\",\n \"created_at\": \"1993-08-08T22:37:24.691Z\",\n \"modified_at\": \"1997-01-15T07:09:33.666Z\",\n \"note\": \"sint officia\"\n },\n \"id\": \"dolore enim qui exercitation ni\"\n }\n }\n ]\n },\n \"id\": \"quis amet\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": true,\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"ex dolor\",\n \"created_at\": \"2009-12-03T11:44:52.134Z\",\n \"modified_at\": \"1959-12-24T16:13:38.278Z\",\n \"note\": \"id elit\"\n },\n \"id\": \"velit consectetur E\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"in eiusmod\",\n \"created_at\": \"1966-12-20T11:32:11.805Z\",\n \"modified_at\": \"2021-08-20T00:58:12.658Z\",\n \"note\": \"ea e\"\n },\n \"id\": \"magna labore\"\n }\n }\n ]\n },\n \"id\": \"elit enim\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": true,\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"ex dolor\",\n \"created_at\": \"2009-12-03T11:44:52.134Z\",\n \"modified_at\": \"1959-12-24T16:13:38.278Z\",\n \"note\": \"id elit\"\n },\n \"id\": \"velit consectetur E\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"in eiusmod\",\n \"created_at\": \"1966-12-20T11:32:11.805Z\",\n \"modified_at\": \"2021-08-20T00:58:12.658Z\",\n \"note\": \"ea e\"\n },\n \"id\": \"magna labore\"\n }\n }\n ]\n },\n \"id\": \"elit enim\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": true,\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"ex dolor\",\n \"created_at\": \"2009-12-03T11:44:52.134Z\",\n \"modified_at\": \"1959-12-24T16:13:38.278Z\",\n \"note\": \"id elit\"\n },\n \"id\": \"velit consectetur E\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"in eiusmod\",\n \"created_at\": \"1966-12-20T11:32:11.805Z\",\n \"modified_at\": \"2021-08-20T00:58:12.658Z\",\n \"note\": \"ea e\"\n },\n \"id\": \"magna labore\"\n }\n }\n ]\n },\n \"id\": \"elit enim\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": true,\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"ex dolor\",\n \"created_at\": \"2009-12-03T11:44:52.134Z\",\n \"modified_at\": \"1959-12-24T16:13:38.278Z\",\n \"note\": \"id elit\"\n },\n \"id\": \"velit consectetur E\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"in eiusmod\",\n \"created_at\": \"1966-12-20T11:32:11.805Z\",\n \"modified_at\": \"2021-08-20T00:58:12.658Z\",\n \"note\": \"ea e\"\n },\n \"id\": \"magna labore\"\n }\n }\n ]\n },\n \"id\": \"elit enim\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "The IP allowlist API is used to manage the IP addresses that\ncan access the Datadog API and web UI. It does not block\naccess to intake APIs or public dashboards.\n\nThis is an enterprise-only feature. Request access by\ncontacting Datadog support, or see the [IP Allowlist page](https://docs.datadoghq.com/account_management/org_settings/ip_allowlist/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "IP Ranges",
"item": [
{
"name": "List IP Ranges",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://{{subdomain}}.{{site}}/",
"protocol": "https",
"host": [
"{{subdomain}}",
"{{site}}"
],
"path": [
""
]
},
"description": "Get information about Datadog IP ranges."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "https://{{subdomain}}.{{site}}/",
"protocol": "https",
"host": [
"{{subdomain}}",
"{{site}}"
],
"path": [
""
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"agents\": {\n \"prefixes_ipv4\": [\n \"sint nostrud\",\n \"in non aliqua\"\n ],\n \"prefixes_ipv6\": [\n \"ipsum\",\n \"aute nostrud nisi Duis sint\"\n ]\n },\n \"api\": {\n \"prefixes_ipv4\": [\n \"reprehenderit ut aliquip culpa officia\",\n \"in ipsum ea occaecat\"\n ],\n \"prefixes_ipv6\": [\n \"dolor consectetur\",\n \"ullamco pariatur\"\n ]\n },\n \"apm\": {\n \"prefixes_ipv4\": [\n \"in Lorem\",\n \"ipsum\"\n ],\n \"prefixes_ipv6\": [\n \"Duis\",\n \"eu proident sit dolore\"\n ]\n },\n \"global\": {\n \"prefixes_ipv4\": [\n \"sint et\",\n \"dolore ullamco amet qui Ut\"\n ],\n \"prefixes_ipv6\": [\n \"velit laboris exercitation consequat nulla\",\n \"in dolor cupidatat\"\n ]\n },\n \"logs\": {\n \"prefixes_ipv4\": [\n \"ad Lorem amet\",\n \"ut\"\n ],\n \"prefixes_ipv6\": [\n \"labore occaecat nulla pariatur\",\n \"Lorem dolor\"\n ]\n },\n \"modified\": \"2019-10-31-20-00-00\",\n \"orchestrator\": {\n \"prefixes_ipv4\": [\n \"qui laborum cillum ex\",\n \"ea Lor\"\n ],\n \"prefixes_ipv6\": [\n \"dolor nostrud\",\n \"cupidatat do dolore enim\"\n ]\n },\n \"process\": {\n \"prefixes_ipv4\": [\n \"consectetur n\",\n \"minim i\"\n ],\n \"prefixes_ipv6\": [\n \"voluptate irure dolor elit\",\n \"et Duis ad tempor adipisicing\"\n ]\n },\n \"remote-configuration\": {\n \"prefixes_ipv4\": [\n \"eiusmod\",\n \"eiusmod Excepteur elit in\"\n ],\n \"prefixes_ipv6\": [\n \"cupidatat mollit consequat\",\n \"quis mollit in\"\n ]\n },\n \"synthetics\": {\n \"prefixes_ipv4\": [\n \"mollit est id do\",\n \"officia pariatur occaecat\"\n ],\n \"prefixes_ipv4_by_location\": {\n \"quis_b78\": [\n \"et\",\n \"fugiat Lorem\"\n ]\n },\n \"prefixes_ipv6\": [\n \"laboris officia aute\",\n \"id tempor\"\n ],\n \"prefixes_ipv6_by_location\": {\n \"ipsumf\": [\n \"Excepteur sit in eiusmod elit\",\n \"ut nisi\"\n ],\n \"do_c\": [\n \"ad\",\n \"fugiat proident\"\n ]\n }\n },\n \"synthetics-private-locations\": {\n \"prefixes_ipv4\": [\n \"nisi deserunt\",\n \"est in ullamco\"\n ],\n \"prefixes_ipv6\": [\n \"deserun\",\n \"magna nostrud reprehenderit dolor consequat\"\n ]\n },\n \"version\": 11,\n \"webhooks\": {\n \"prefixes_ipv4\": [\n \"nisi Duis laboris\",\n \"tempor dolor nisi\"\n ],\n \"prefixes_ipv6\": [\n \"enim\",\n \"sed irure\"\n ]\n }\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "https://{{subdomain}}.{{site}}/",
"protocol": "https",
"host": [
"{{subdomain}}",
"{{site}}"
],
"path": [
""
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Get a list of IP prefixes belonging to Datadog.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Key Management",
"item": [
{
"name": "Delete an application key owned by current user",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete an application key owned by current user"
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all API keys",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "API key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter API keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys created on or before the specified date.",
"disabled": true
},
{
"key": "filter[modified_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys modified on or after the specified date.",
"disabled": true
},
{
"key": "filter[modified_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys modified on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "created_by,modified_by",
"description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`.",
"disabled": true
},
{
"key": "filter[remote_config_read_enabled]",
"value": "false",
"description": "Filter API keys by remote config read enabled status.",
"disabled": true
},
{
"key": "filter[category]",
"value": "pariatur consequat",
"description": "Filter API keys by category.",
"disabled": true
}
]
},
"description": "List all API keys available for your account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "API key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter API keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys created on or before the specified date.",
"disabled": true
},
{
"key": "filter[modified_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys modified on or after the specified date.",
"disabled": true
},
{
"key": "filter[modified_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys modified on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "created_by,modified_by",
"description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`.",
"disabled": true
},
{
"key": "filter[remote_config_read_enabled]",
"value": "false",
"description": "Filter API keys by remote config read enabled status.",
"disabled": true
},
{
"key": "filter[category]",
"value": "pariatur consequat",
"description": "Filter API keys by category.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"category\": \"exercitation Excepteur\",\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"last4\": \"abcd\",\n \"modified_at\": \"2020-11-23T10:00:00.000Z\",\n \"name\": \"API Key for submitting metrics\",\n \"remote_config_read_enabled\": false\n },\n \"id\": \"voluptate cupidatat esse\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"api_keys\"\n },\n {\n \"attributes\": {\n \"category\": \"dolore veniam\",\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"last4\": \"abcd\",\n \"modified_at\": \"2020-11-23T10:00:00.000Z\",\n \"name\": \"API Key for submitting metrics\",\n \"remote_config_read_enabled\": true\n },\n \"id\": \"exercitation do quis officia\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"api_keys\"\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1984-12-17T07:04:27.304Z\",\n \"disabled\": false,\n \"email\": \"tempor aliqua\",\n \"handle\": \"eu elit Ut amet\",\n \"icon\": \"labore l\",\n \"modified_at\": \"1990-02-12T03:44:40.115Z\",\n \"name\": \"nostrud deserunt tempor proident\",\n \"service_account\": false,\n \"status\": \"commodo consequat\",\n \"title\": \"in sit Ut ad dolor\",\n \"verified\": true\n },\n \"id\": \"dolore\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2005-11-27T22:13:29.945Z\",\n \"disabled\": false,\n \"email\": \"aute nisi ipsum\",\n \"handle\": \"dolor eu voluptate occaecat\",\n \"icon\": \"sunt ullamco do velit\",\n \"modified_at\": \"2009-04-15T14:52:08.249Z\",\n \"name\": \"quis Lorem\",\n \"service_account\": false,\n \"status\": \"fugiat deserunt commodo quis\",\n \"title\": \"labore\",\n \"verified\": true\n },\n \"id\": \"aute sunt sed sint\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ],\n \"meta\": {\n \"max_allowed\": -83556793,\n \"page\": {\n \"total_filtered_count\": 59250628\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "API key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter API keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys created on or before the specified date.",
"disabled": true
},
{
"key": "filter[modified_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys modified on or after the specified date.",
"disabled": true
},
{
"key": "filter[modified_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys modified on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "created_by,modified_by",
"description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`.",
"disabled": true
},
{
"key": "filter[remote_config_read_enabled]",
"value": "false",
"description": "Filter API keys by remote config read enabled status.",
"disabled": true
},
{
"key": "filter[category]",
"value": "pariatur consequat",
"description": "Filter API keys by category.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "API key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter API keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys created on or before the specified date.",
"disabled": true
},
{
"key": "filter[modified_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys modified on or after the specified date.",
"disabled": true
},
{
"key": "filter[modified_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys modified on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "created_by,modified_by",
"description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`.",
"disabled": true
},
{
"key": "filter[remote_config_read_enabled]",
"value": "false",
"description": "Filter API keys by remote config read enabled status.",
"disabled": true
},
{
"key": "filter[category]",
"value": "pariatur consequat",
"description": "Filter API keys by category.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "API key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter API keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys created on or before the specified date.",
"disabled": true
},
{
"key": "filter[modified_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys modified on or after the specified date.",
"disabled": true
},
{
"key": "filter[modified_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include API keys modified on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "created_by,modified_by",
"description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`.",
"disabled": true
},
{
"key": "filter[remote_config_read_enabled]",
"value": "false",
"description": "Filter API keys by remote config read enabled status.",
"disabled": true
},
{
"key": "filter[category]",
"value": "pariatur consequat",
"description": "Filter API keys by category.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create an API key",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"API Key for submitting metrics\"\n },\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys"
]
},
"description": "Create an API key."
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"API Key for submitting metrics\"\n },\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"category\": \"labore in consequat\",\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"key\": \"eu quis ullamco\",\n \"last4\": \"abcd\",\n \"modified_at\": \"2020-11-23T10:00:00.000Z\",\n \"name\": \"API Key for submitting metrics\",\n \"remote_config_read_enabled\": false\n },\n \"id\": \"pariatur elit aute fugiat\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"api_keys\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1954-02-08T22:21:36.630Z\",\n \"disabled\": true,\n \"email\": \"sunt in\",\n \"handle\": \"voluptate nisi reprehenderit enim\",\n \"icon\": \"incididunt ut eiusmod\",\n \"modified_at\": \"1985-04-07T13:40:41.162Z\",\n \"name\": \"mollit\",\n \"service_account\": false,\n \"status\": \"adipisicing irure nisi\",\n \"title\": \"officia do\",\n \"verified\": true\n },\n \"id\": \"id anim incididunt ullamco dolor\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1971-04-19T13:50:39.290Z\",\n \"disabled\": false,\n \"email\": \"commodo eiusmod adipisicing pariatur\",\n \"handle\": \"sit ipsum Lorem\",\n \"icon\": \"ut consectetur laborum\",\n \"modified_at\": \"1968-01-08T09:10:30.083Z\",\n \"name\": \"quis laboris\",\n \"service_account\": true,\n \"status\": \"pariatur fugiat ut ex labore\",\n \"title\": \"in cillum laboris officia voluptate\",\n \"verified\": true\n },\n \"id\": \"nulla ea\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"API Key for submitting metrics\"\n },\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"API Key for submitting metrics\"\n },\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"API Key for submitting metrics\"\n },\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Edit an application key owned by current user",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id",
"value": "pariatur consequat"
}
]
},
"description": "Edit an application key owned by current user"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"key\": \"et ad cillum t\",\n \"last4\": \"abcd\",\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"minim in ipsum mollit\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"2023-03-27T01:31:32.607Z\",\n \"disabled\": true,\n \"email\": \"in\",\n \"handle\": \"anim nostrud voluptate esse\",\n \"icon\": \"quis ea\",\n \"modified_at\": \"1977-03-03T23:21:21.295Z\",\n \"name\": \"eu dolore labore Duis nisi\",\n \"service_account\": false,\n \"status\": \"exercitation dolor Excepteur\",\n \"title\": \"in enim esse quis consectetur\",\n \"verified\": false\n },\n \"id\": \"est cupidatat mollit velit\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1944-12-10T14:07:03.278Z\",\n \"disabled\": false,\n \"email\": \"sed aliqua\",\n \"handle\": \"voluptate adipisicing dolor tempor\",\n \"icon\": \"cillum do mollit\",\n \"modified_at\": \"1983-07-06T02:46:58.072Z\",\n \"name\": \"culpa est\",\n \"service_account\": false,\n \"status\": \"eiusmod do\",\n \"title\": \"nulla magna proident\",\n \"verified\": false\n },\n \"id\": \"proident nisi occaecat\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get API key",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"query": [
{
"key": "include",
"value": "created_by,modified_by",
"description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`.",
"disabled": true
}
],
"variable": [
{
"key": "api_key_id",
"value": "pariatur consequat"
}
]
},
"description": "Get an API key."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"query": [
{
"key": "include",
"value": "created_by,modified_by",
"description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`.",
"disabled": true
}
],
"variable": [
{
"key": "api_key_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"category\": \"labore in consequat\",\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"key\": \"eu quis ullamco\",\n \"last4\": \"abcd\",\n \"modified_at\": \"2020-11-23T10:00:00.000Z\",\n \"name\": \"API Key for submitting metrics\",\n \"remote_config_read_enabled\": false\n },\n \"id\": \"pariatur elit aute fugiat\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"api_keys\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1954-02-08T22:21:36.630Z\",\n \"disabled\": true,\n \"email\": \"sunt in\",\n \"handle\": \"voluptate nisi reprehenderit enim\",\n \"icon\": \"incididunt ut eiusmod\",\n \"modified_at\": \"1985-04-07T13:40:41.162Z\",\n \"name\": \"mollit\",\n \"service_account\": false,\n \"status\": \"adipisicing irure nisi\",\n \"title\": \"officia do\",\n \"verified\": true\n },\n \"id\": \"id anim incididunt ullamco dolor\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1971-04-19T13:50:39.290Z\",\n \"disabled\": false,\n \"email\": \"commodo eiusmod adipisicing pariatur\",\n \"handle\": \"sit ipsum Lorem\",\n \"icon\": \"ut consectetur laborum\",\n \"modified_at\": \"1968-01-08T09:10:30.083Z\",\n \"name\": \"quis laboris\",\n \"service_account\": true,\n \"status\": \"pariatur fugiat ut ex labore\",\n \"title\": \"in cillum laboris officia voluptate\",\n \"verified\": true\n },\n \"id\": \"nulla ea\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"query": [
{
"key": "include",
"value": "created_by,modified_by",
"description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`.",
"disabled": true
}
],
"variable": [
{
"key": "api_key_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"query": [
{
"key": "include",
"value": "created_by,modified_by",
"description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`.",
"disabled": true
}
],
"variable": [
{
"key": "api_key_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"query": [
{
"key": "include",
"value": "created_by,modified_by",
"description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`.",
"disabled": true
}
],
"variable": [
{
"key": "api_key_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get one application key owned by current user",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id",
"value": "pariatur consequat"
}
]
},
"description": "Get an application key owned by current user"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"key\": \"et ad cillum t\",\n \"last4\": \"abcd\",\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"minim in ipsum mollit\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"2023-03-27T01:31:32.607Z\",\n \"disabled\": true,\n \"email\": \"in\",\n \"handle\": \"anim nostrud voluptate esse\",\n \"icon\": \"quis ea\",\n \"modified_at\": \"1977-03-03T23:21:21.295Z\",\n \"name\": \"eu dolore labore Duis nisi\",\n \"service_account\": false,\n \"status\": \"exercitation dolor Excepteur\",\n \"title\": \"in enim esse quis consectetur\",\n \"verified\": false\n },\n \"id\": \"est cupidatat mollit velit\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1944-12-10T14:07:03.278Z\",\n \"disabled\": false,\n \"email\": \"sed aliqua\",\n \"handle\": \"voluptate adipisicing dolor tempor\",\n \"icon\": \"cillum do mollit\",\n \"modified_at\": \"1983-07-06T02:46:58.072Z\",\n \"name\": \"culpa est\",\n \"service_account\": false,\n \"status\": \"eiusmod do\",\n \"title\": \"nulla magna proident\",\n \"verified\": false\n },\n \"id\": \"proident nisi occaecat\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create an application key for current user",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys"
]
},
"description": "Create an application key for current user"
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"key\": \"et ad cillum t\",\n \"last4\": \"abcd\",\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"minim in ipsum mollit\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"2023-03-27T01:31:32.607Z\",\n \"disabled\": true,\n \"email\": \"in\",\n \"handle\": \"anim nostrud voluptate esse\",\n \"icon\": \"quis ea\",\n \"modified_at\": \"1977-03-03T23:21:21.295Z\",\n \"name\": \"eu dolore labore Duis nisi\",\n \"service_account\": false,\n \"status\": \"exercitation dolor Excepteur\",\n \"title\": \"in enim esse quis consectetur\",\n \"verified\": false\n },\n \"id\": \"est cupidatat mollit velit\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1944-12-10T14:07:03.278Z\",\n \"disabled\": false,\n \"email\": \"sed aliqua\",\n \"handle\": \"voluptate adipisicing dolor tempor\",\n \"icon\": \"cillum do mollit\",\n \"modified_at\": \"1983-07-06T02:46:58.072Z\",\n \"name\": \"culpa est\",\n \"service_account\": false,\n \"status\": \"eiusmod do\",\n \"title\": \"nulla magna proident\",\n \"verified\": false\n },\n \"id\": \"proident nisi occaecat\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Edit an API key",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"API Key for submitting metrics\"\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_id",
"value": "pariatur consequat"
}
]
},
"description": "Update an API key."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"API Key for submitting metrics\"\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"category\": \"labore in consequat\",\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"key\": \"eu quis ullamco\",\n \"last4\": \"abcd\",\n \"modified_at\": \"2020-11-23T10:00:00.000Z\",\n \"name\": \"API Key for submitting metrics\",\n \"remote_config_read_enabled\": false\n },\n \"id\": \"pariatur elit aute fugiat\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n },\n \"modified_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"api_keys\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1954-02-08T22:21:36.630Z\",\n \"disabled\": true,\n \"email\": \"sunt in\",\n \"handle\": \"voluptate nisi reprehenderit enim\",\n \"icon\": \"incididunt ut eiusmod\",\n \"modified_at\": \"1985-04-07T13:40:41.162Z\",\n \"name\": \"mollit\",\n \"service_account\": false,\n \"status\": \"adipisicing irure nisi\",\n \"title\": \"officia do\",\n \"verified\": true\n },\n \"id\": \"id anim incididunt ullamco dolor\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1971-04-19T13:50:39.290Z\",\n \"disabled\": false,\n \"email\": \"commodo eiusmod adipisicing pariatur\",\n \"handle\": \"sit ipsum Lorem\",\n \"icon\": \"ut consectetur laborum\",\n \"modified_at\": \"1968-01-08T09:10:30.083Z\",\n \"name\": \"quis laboris\",\n \"service_account\": true,\n \"status\": \"pariatur fugiat ut ex labore\",\n \"title\": \"in cillum laboris officia voluptate\",\n \"verified\": true\n },\n \"id\": \"nulla ea\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"API Key for submitting metrics\"\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"API Key for submitting metrics\"\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"API Key for submitting metrics\"\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"API Key for submitting metrics\"\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"api_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete an API key",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete an API key."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys",
":api_key_id"
],
"variable": [
{
"key": "api_key_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all application keys owned by current user",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
]
},
"description": "List all application keys available for current user"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"last4\": \"abcd\",\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"nostrud\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"last4\": \"abcd\",\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"magna ut\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1961-12-26T09:33:04.908Z\",\n \"disabled\": false,\n \"email\": \"eu ut dolore aute\",\n \"handle\": \"sunt anim veniam fugiat\",\n \"icon\": \"sunt fugiat Lorem adipisicing sit\",\n \"modified_at\": \"2010-02-06T08:06:38.022Z\",\n \"name\": \"mollit reprehenderit dolor cupidatat\",\n \"service_account\": false,\n \"status\": \"incididunt esse\",\n \"title\": \"sed officia pariatur\",\n \"verified\": true\n },\n \"id\": \"reprehenderit cillum adipisi\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1983-11-29T18:09:08.094Z\",\n \"disabled\": false,\n \"email\": \"Duis\",\n \"handle\": \"sunt ut do\",\n \"icon\": \"velit sit\",\n \"modified_at\": \"1951-11-07T11:04:55.182Z\",\n \"name\": \"qui labore\",\n \"service_account\": true,\n \"status\": \"id aute velit dolor\",\n \"title\": \"et Excepteur\",\n \"verified\": true\n },\n \"id\": \"in amet qui aute\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ],\n \"meta\": {\n \"max_allowed_per_user\": -38029116,\n \"page\": {\n \"total_filtered_count\": 22366699\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all application keys",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
]
},
"description": "List all application keys available for your org"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"last4\": \"abcd\",\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"nostrud\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"last4\": \"abcd\",\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"magna ut\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1961-12-26T09:33:04.908Z\",\n \"disabled\": false,\n \"email\": \"eu ut dolore aute\",\n \"handle\": \"sunt anim veniam fugiat\",\n \"icon\": \"sunt fugiat Lorem adipisicing sit\",\n \"modified_at\": \"2010-02-06T08:06:38.022Z\",\n \"name\": \"mollit reprehenderit dolor cupidatat\",\n \"service_account\": false,\n \"status\": \"incididunt esse\",\n \"title\": \"sed officia pariatur\",\n \"verified\": true\n },\n \"id\": \"reprehenderit cillum adipisi\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1983-11-29T18:09:08.094Z\",\n \"disabled\": false,\n \"email\": \"Duis\",\n \"handle\": \"sunt ut do\",\n \"icon\": \"velit sit\",\n \"modified_at\": \"1951-11-07T11:04:55.182Z\",\n \"name\": \"qui labore\",\n \"service_account\": true,\n \"status\": \"id aute velit dolor\",\n \"title\": \"et Excepteur\",\n \"verified\": true\n },\n \"id\": \"in amet qui aute\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ],\n \"meta\": {\n \"max_allowed_per_user\": -38029116,\n \"page\": {\n \"total_filtered_count\": 22366699\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
},
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create an application key",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"hash\": \"1234512345123459cda4eb9ced49a3d84fd0138c\",\n \"name\": \"example user\",\n \"owner\": \"example.com\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/application_key",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"application_key"
]
},
"description": "Create an application key with a given name."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"hash\": \"1234512345123459cda4eb9ced49a3d84fd0138c\",\n \"name\": \"example user\",\n \"owner\": \"example.com\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/application_key",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"application_key"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"application_key\": {\n \"hash\": \"1234512345123459cda4eb9ced49a3d84fd0138c\",\n \"name\": \"app_key\",\n \"owner\": \"test_user\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"hash\": \"1234512345123459cda4eb9ced49a3d84fd0138c\",\n \"name\": \"example user\",\n \"owner\": \"example.com\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/application_key",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"application_key"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"hash\": \"1234512345123459cda4eb9ced49a3d84fd0138c\",\n \"name\": \"example user\",\n \"owner\": \"example.com\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/application_key",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"application_key"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"hash\": \"1234512345123459cda4eb9ced49a3d84fd0138c\",\n \"name\": \"example user\",\n \"owner\": \"example.com\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/application_key",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"application_key"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"hash\": \"1234512345123459cda4eb9ced49a3d84fd0138c\",\n \"name\": \"example user\",\n \"owner\": \"example.com\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/application_key",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"application_key"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get an application key",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"query": [
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
],
"variable": [
{
"key": "app_key_id",
"value": "pariatur consequat"
}
]
},
"description": "Get an application key for your org."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"query": [
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"key\": \"et ad cillum t\",\n \"last4\": \"abcd\",\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"minim in ipsum mollit\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"2023-03-27T01:31:32.607Z\",\n \"disabled\": true,\n \"email\": \"in\",\n \"handle\": \"anim nostrud voluptate esse\",\n \"icon\": \"quis ea\",\n \"modified_at\": \"1977-03-03T23:21:21.295Z\",\n \"name\": \"eu dolore labore Duis nisi\",\n \"service_account\": false,\n \"status\": \"exercitation dolor Excepteur\",\n \"title\": \"in enim esse quis consectetur\",\n \"verified\": false\n },\n \"id\": \"est cupidatat mollit velit\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1944-12-10T14:07:03.278Z\",\n \"disabled\": false,\n \"email\": \"sed aliqua\",\n \"handle\": \"voluptate adipisicing dolor tempor\",\n \"icon\": \"cillum do mollit\",\n \"modified_at\": \"1983-07-06T02:46:58.072Z\",\n \"name\": \"culpa est\",\n \"service_account\": false,\n \"status\": \"eiusmod do\",\n \"title\": \"nulla magna proident\",\n \"verified\": false\n },\n \"id\": \"proident nisi occaecat\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"query": [
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"query": [
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"query": [
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"query": [
{
"key": "include",
"value": "owned_by",
"description": "Resource path for related resources to include in the response. Only `owned_by` is supported.",
"disabled": true
}
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Edit an application key",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id",
"value": "pariatur consequat"
}
]
},
"description": "Edit an application key"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"key\": \"et ad cillum t\",\n \"last4\": \"abcd\",\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"minim in ipsum mollit\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"2023-03-27T01:31:32.607Z\",\n \"disabled\": true,\n \"email\": \"in\",\n \"handle\": \"anim nostrud voluptate esse\",\n \"icon\": \"quis ea\",\n \"modified_at\": \"1977-03-03T23:21:21.295Z\",\n \"name\": \"eu dolore labore Duis nisi\",\n \"service_account\": false,\n \"status\": \"exercitation dolor Excepteur\",\n \"title\": \"in enim esse quis consectetur\",\n \"verified\": false\n },\n \"id\": \"est cupidatat mollit velit\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1944-12-10T14:07:03.278Z\",\n \"disabled\": false,\n \"email\": \"sed aliqua\",\n \"handle\": \"voluptate adipisicing dolor tempor\",\n \"icon\": \"cillum do mollit\",\n \"modified_at\": \"1983-07-06T02:46:58.072Z\",\n \"name\": \"culpa est\",\n \"service_account\": false,\n \"status\": \"eiusmod do\",\n \"title\": \"nulla magna proident\",\n \"verified\": false\n },\n \"id\": \"proident nisi occaecat\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete an application key",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete an application key"
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Manage your Datadog API and application keys. You need an API key and\nan application key for a user with the required permissions to interact\nwith these endpoints. The full list of API and application keys can be\nseen on your [Datadog API page](https://app.datadoghq.com/account/settings#api).",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Logs",
"item": [
{
"name": "Send logs",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "gzip",
"description": "HTTP header used to compress the media-type.",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello\",\n \"service\": \"payment\"\n },\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345679\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] World\",\n \"service\": \"payment\"\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "https://http-intake.logs.{{site}}/api/v2/logs?ddtags=<string>",
"protocol": "https",
"host": [
"http-intake",
"logs",
"{{site}}"
],
"path": [
"api",
"v2",
"logs"
],
"query": [
{
"key": "ddtags",
"value": "<string>",
"description": "Log tags can be passed as query parameters with `text/plain` content type."
}
]
},
"description": "Send your logs to your Datadog platform over HTTP. Limits per HTTP request are:\n\n- Maximum content size per payload (uncompressed): 5MB\n- Maximum size for a single log: 1MB\n- Maximum array size if sending multiple logs in an array: 1000 entries\n\nAny log exceeding 1MB is accepted and truncated by Datadog:\n- For a single log request, the API truncates the log at 1MB and returns a 2xx.\n- For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx.\n\nDatadog recommends sending your logs compressed.\nAdd the `Content-Encoding: gzip` header to the request when sending compressed logs.\nLog events can be submitted with a timestamp that is up to 18 hours in the past.\n\nThe status codes answered by the HTTP API are:\n- 202: Accepted: the request has been accepted for processing\n- 400: Bad request (likely an issue in the payload formatting)\n- 401: Unauthorized (likely a missing API Key)\n- 403: Permission issue (likely using an invalid API Key)\n- 408: Request Timeout, request should be retried after some time\n- 413: Payload too large (batch is above 5MB uncompressed)\n- 429: Too Many Requests, request should be retried after some time\n- 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time\n- 503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, request should be retried after some time"
},
"response": [
{
"name": "Request accepted for processing (always 202 empty JSON).",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "gzip",
"description": "HTTP header used to compress the media-type.",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello\",\n \"service\": \"payment\"\n },\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345679\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] World\",\n \"service\": \"payment\"\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "https://{{subdomain}}.{{site}}/api/v2/logs",
"protocol": "https",
"host": [
"{{subdomain}}",
"{{site}}"
],
"path": [
"api",
"v2",
"logs"
],
"query": [
{
"key": "ddtags",
"value": "env:prod,user:my-user",
"description": "Log tags can be passed as query parameters with `text/plain` content type.",
"disabled": true
}
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "gzip",
"description": "HTTP header used to compress the media-type.",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello\",\n \"service\": \"payment\"\n },\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345679\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] World\",\n \"service\": \"payment\"\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "https://{{subdomain}}.{{site}}/api/v2/logs",
"protocol": "https",
"host": [
"{{subdomain}}",
"{{site}}"
],
"path": [
"api",
"v2",
"logs"
],
"query": [
{
"key": "ddtags",
"value": "env:prod,user:my-user",
"description": "Log tags can be passed as query parameters with `text/plain` content type.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "gzip",
"description": "HTTP header used to compress the media-type.",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello\",\n \"service\": \"payment\"\n },\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345679\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] World\",\n \"service\": \"payment\"\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "https://{{subdomain}}.{{site}}/api/v2/logs",
"protocol": "https",
"host": [
"{{subdomain}}",
"{{site}}"
],
"path": [
"api",
"v2",
"logs"
],
"query": [
{
"key": "ddtags",
"value": "env:prod,user:my-user",
"description": "Log tags can be passed as query parameters with `text/plain` content type.",
"disabled": true
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "gzip",
"description": "HTTP header used to compress the media-type.",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello\",\n \"service\": \"payment\"\n },\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345679\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] World\",\n \"service\": \"payment\"\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "https://{{subdomain}}.{{site}}/api/v2/logs",
"protocol": "https",
"host": [
"{{subdomain}}",
"{{site}}"
],
"path": [
"api",
"v2",
"logs"
],
"query": [
{
"key": "ddtags",
"value": "env:prod,user:my-user",
"description": "Log tags can be passed as query parameters with `text/plain` content type.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Request Timeout",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "gzip",
"description": "HTTP header used to compress the media-type.",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello\",\n \"service\": \"payment\"\n },\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345679\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] World\",\n \"service\": \"payment\"\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "https://{{subdomain}}.{{site}}/api/v2/logs",
"protocol": "https",
"host": [
"{{subdomain}}",
"{{site}}"
],
"path": [
"api",
"v2",
"logs"
],
"query": [
{
"key": "ddtags",
"value": "env:prod,user:my-user",
"description": "Log tags can be passed as query parameters with `text/plain` content type.",
"disabled": true
}
]
}
},
"status": "Request Timeout",
"code": 408,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Payload Too Large",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "gzip",
"description": "HTTP header used to compress the media-type.",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello\",\n \"service\": \"payment\"\n },\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345679\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] World\",\n \"service\": \"payment\"\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "https://{{subdomain}}.{{site}}/api/v2/logs",
"protocol": "https",
"host": [
"{{subdomain}}",
"{{site}}"
],
"path": [
"api",
"v2",
"logs"
],
"query": [
{
"key": "ddtags",
"value": "env:prod,user:my-user",
"description": "Log tags can be passed as query parameters with `text/plain` content type.",
"disabled": true
}
]
}
},
"status": "Request Entity Too Large",
"code": 413,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "gzip",
"description": "HTTP header used to compress the media-type.",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello\",\n \"service\": \"payment\"\n },\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345679\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] World\",\n \"service\": \"payment\"\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "https://{{subdomain}}.{{site}}/api/v2/logs",
"protocol": "https",
"host": [
"{{subdomain}}",
"{{site}}"
],
"path": [
"api",
"v2",
"logs"
],
"query": [
{
"key": "ddtags",
"value": "env:prod,user:my-user",
"description": "Log tags can be passed as query parameters with `text/plain` content type.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Internal Server Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "gzip",
"description": "HTTP header used to compress the media-type.",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello\",\n \"service\": \"payment\"\n },\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345679\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] World\",\n \"service\": \"payment\"\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "https://{{subdomain}}.{{site}}/api/v2/logs",
"protocol": "https",
"host": [
"{{subdomain}}",
"{{site}}"
],
"path": [
"api",
"v2",
"logs"
],
"query": [
{
"key": "ddtags",
"value": "env:prod,user:my-user",
"description": "Log tags can be passed as query parameters with `text/plain` content type.",
"disabled": true
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Service Unavailable",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "gzip",
"description": "HTTP header used to compress the media-type.",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello\",\n \"service\": \"payment\"\n },\n {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345679\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] World\",\n \"service\": \"payment\"\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "https://{{subdomain}}.{{site}}/api/v2/logs",
"protocol": "https",
"host": [
"{{subdomain}}",
"{{site}}"
],
"path": [
"api",
"v2",
"logs"
],
"query": [
{
"key": "ddtags",
"value": "env:prod,user:my-user",
"description": "Log tags can be passed as query parameters with `text/plain` content type.",
"disabled": true
}
]
}
},
"status": "Service Unavailable",
"code": 503,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Malformed payload\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
},
{
"name": "Aggregate events",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"indexes\": [\n \"main\",\n \"web\"\n ],\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"storage_tier\": \"indexes\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"laborum magna qui\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n },\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"sit quis proident\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n }\n ],\n \"options\": {\n \"timeOffset\": 90728825,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"analytics",
"aggregate"
]
},
"description": "The API endpoint to aggregate events into buckets and compute metrics and timeseries."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"indexes\": [\n \"main\",\n \"web\"\n ],\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"storage_tier\": \"indexes\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"laborum magna qui\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n },\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"sit quis proident\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n }\n ],\n \"options\": {\n \"timeOffset\": 90728825,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"analytics",
"aggregate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"buckets\": [\n {\n \"by\": {\n \"@state\": \"success\",\n \"@version\": \"abc\"\n },\n \"computes\": {\n \"consequat_6\": \"labo\",\n \"consequat_e\": \"id eu Excepteur quis\",\n \"ipsumb\": \"ex veniam est in\"\n }\n },\n {\n \"by\": {\n \"@state\": \"success\",\n \"@version\": \"abc\"\n },\n \"computes\": {\n \"commodo_\": \"magna dolor\",\n \"veniam_d\": \"culpa dolore\"\n }\n }\n ]\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"indexes\": [\n \"main\",\n \"web\"\n ],\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"storage_tier\": \"indexes\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"laborum magna qui\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n },\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"sit quis proident\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n }\n ],\n \"options\": {\n \"timeOffset\": 90728825,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"analytics",
"aggregate"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"indexes\": [\n \"main\",\n \"web\"\n ],\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"storage_tier\": \"indexes\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"laborum magna qui\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n },\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"sit quis proident\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n }\n ],\n \"options\": {\n \"timeOffset\": 90728825,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"analytics",
"aggregate"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"indexes\": [\n \"main\",\n \"web\"\n ],\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"storage_tier\": \"indexes\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"laborum magna qui\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n },\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"sit quis proident\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n }\n ],\n \"options\": {\n \"timeOffset\": 90728825,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"analytics",
"aggregate"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Search logs",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"indexes\": [\n \"main\",\n \"web\"\n ],\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"storage_tier\": \"indexes\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": 77319958,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"events",
"search"
]
},
"description": "List endpoint returns logs that match a log search query.\n[Results are paginated][1].\n\nUse this endpoint to build complex logs filtering and search.\n\n**If you are considering archiving logs for your organization,\nconsider use of the Datadog archive capabilities instead of the log list API.\nSee [Datadog Logs Archive documentation][2].**\n\n[1]: /logs/guide/collect-multiple-logs-with-pagination\n[2]: https://docs.datadoghq.com/logs/archives"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"indexes\": [\n \"main\",\n \"web\"\n ],\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"storage_tier\": \"indexes\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": 77319958,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"events",
"search"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"host\": \"i-0123\",\n \"message\": \"Host connected to remote\",\n \"service\": \"agent\",\n \"status\": \"INFO\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"log\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"host\": \"i-0123\",\n \"message\": \"Host connected to remote\",\n \"service\": \"agent\",\n \"status\": \"INFO\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"log\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/logs/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"indexes\": [\n \"main\",\n \"web\"\n ],\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"storage_tier\": \"indexes\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": 77319958,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"events",
"search"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"indexes\": [\n \"main\",\n \"web\"\n ],\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"storage_tier\": \"indexes\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": 77319958,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"events",
"search"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"indexes\": [\n \"main\",\n \"web\"\n ],\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"storage_tier\": \"indexes\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": 77319958,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"events",
"search"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a list of logs",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@datacenter:us @role:db",
"description": "Search query following logs syntax.",
"disabled": true
},
{
"key": "filter[indexes]",
"value": "main,web",
"description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested logs.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested logs.",
"disabled": true
},
{
"key": "filter[storage_tier]",
"value": "indexes",
"description": "Specifies the storage type to be used",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of logs in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of logs in the response.",
"disabled": true
}
]
},
"description": "List endpoint returns logs that match a log search query.\n[Results are paginated][1].\n\nUse this endpoint to see your latest logs.\n\n**If you are considering archiving logs for your organization,\nconsider use of the Datadog archive capabilities instead of the log list API.\nSee [Datadog Logs Archive documentation][2].**\n\n[1]: /logs/guide/collect-multiple-logs-with-pagination\n[2]: https://docs.datadoghq.com/logs/archives"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@datacenter:us @role:db",
"description": "Search query following logs syntax.",
"disabled": true
},
{
"key": "filter[indexes]",
"value": "main,web",
"description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested logs.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested logs.",
"disabled": true
},
{
"key": "filter[storage_tier]",
"value": "indexes",
"description": "Specifies the storage type to be used",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of logs in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of logs in the response.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"host\": \"i-0123\",\n \"message\": \"Host connected to remote\",\n \"service\": \"agent\",\n \"status\": \"INFO\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"log\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"host\": \"i-0123\",\n \"message\": \"Host connected to remote\",\n \"service\": \"agent\",\n \"status\": \"INFO\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"log\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/logs/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@datacenter:us @role:db",
"description": "Search query following logs syntax.",
"disabled": true
},
{
"key": "filter[indexes]",
"value": "main,web",
"description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested logs.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested logs.",
"disabled": true
},
{
"key": "filter[storage_tier]",
"value": "indexes",
"description": "Specifies the storage type to be used",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of logs in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of logs in the response.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@datacenter:us @role:db",
"description": "Search query following logs syntax.",
"disabled": true
},
{
"key": "filter[indexes]",
"value": "main,web",
"description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested logs.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested logs.",
"disabled": true
},
{
"key": "filter[storage_tier]",
"value": "indexes",
"description": "Specifies the storage type to be used",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of logs in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of logs in the response.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@datacenter:us @role:db",
"description": "Search query following logs syntax.",
"disabled": true
},
{
"key": "filter[indexes]",
"value": "main,web",
"description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested logs.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested logs.",
"disabled": true
},
{
"key": "filter[storage_tier]",
"value": "indexes",
"description": "Specifies the storage type to be used",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of logs in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of logs in the response.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Search your logs and send them to your Datadog platform over HTTP. See the [Log Management page](https://docs.datadoghq.com/logs/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Logs Archives",
"item": [
{
"name": "Get all archives",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives"
]
},
"description": "Get the list of configured logs archives with their definitions."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"nisi officia magna in voluptate\",\n \"region\": \"ipsum non sed culpa magna\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ],\n \"state\": \"WORKING\"\n },\n \"id\": \"a2zcMylnM4OCHpYusxIi3g\"\n },\n {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"ut in\",\n \"region\": \"i\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ],\n \"state\": \"WORKING\"\n },\n \"id\": \"a2zcMylnM4OCHpYusxIi3g\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create an archive",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"magna Lorem amet incididunt\",\n \"region\": \"non quis fugiat adipisicing\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives"
]
},
"description": "Create an archive in your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"magna Lorem amet incididunt\",\n \"region\": \"non quis fugiat adipisicing\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"laborum voluptate elit consectetur\",\n \"region\": \"Lorem ut tempor deserunt\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ],\n \"state\": \"WORKING\"\n },\n \"id\": \"a2zcMylnM4OCHpYusxIi3g\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"magna Lorem amet incididunt\",\n \"region\": \"non quis fugiat adipisicing\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"magna Lorem amet incididunt\",\n \"region\": \"non quis fugiat adipisicing\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"magna Lorem amet incididunt\",\n \"region\": \"non quis fugiat adipisicing\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get an archive",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id",
"value": "pariatur consequat"
}
]
},
"description": "Get a specific archive from your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"laborum voluptate elit consectetur\",\n \"region\": \"Lorem ut tempor deserunt\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ],\n \"state\": \"WORKING\"\n },\n \"id\": \"a2zcMylnM4OCHpYusxIi3g\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update an archive",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"magna Lorem amet incididunt\",\n \"region\": \"non quis fugiat adipisicing\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id",
"value": "pariatur consequat"
}
]
},
"description": "Update a given archive configuration.\n\n**Note**: Using this method updates your archive configuration by **replacing**\nyour current configuration with the new one sent to your Datadog organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"magna Lorem amet incididunt\",\n \"region\": \"non quis fugiat adipisicing\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"laborum voluptate elit consectetur\",\n \"region\": \"Lorem ut tempor deserunt\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ],\n \"state\": \"WORKING\"\n },\n \"id\": \"a2zcMylnM4OCHpYusxIi3g\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"magna Lorem amet incididunt\",\n \"region\": \"non quis fugiat adipisicing\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"magna Lorem amet incididunt\",\n \"region\": \"non quis fugiat adipisicing\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"magna Lorem amet incididunt\",\n \"region\": \"non quis fugiat adipisicing\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"Nginx Archive\",\n \"query\": \"source:nginx\",\n \"destination\": {\n \"storage_account\": \"account-name\",\n \"container\": \"container-name\",\n \"integration\": {\n \"tenant_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\",\n \"client_id\": \"aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa\"\n },\n \"type\": \"azure\",\n \"path\": \"magna Lorem amet incididunt\",\n \"region\": \"non quis fugiat adipisicing\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": 100,\n \"rehydration_tags\": [\n \"team:intake\",\n \"team:app\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete an archive",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete a given archive from your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List read roles for an archive",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id",
"value": "pariatur consequat"
}
]
},
"description": "Returns all read roles a given archive is restricted to."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"type\": \"roles\",\n \"attributes\": {\n \"created_at\": \"1968-09-18T01:31:40.786Z\",\n \"modified_at\": \"1945-02-17T17:16:27.246Z\",\n \"name\": \"aliqua labore anim\",\n \"user_count\": 6399991\n },\n \"id\": \"dolor nulla\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"cillum quis\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"commodo est et mollit adipisicing\",\n \"type\": \"permissions\"\n }\n ]\n }\n }\n },\n {\n \"type\": \"roles\",\n \"attributes\": {\n \"created_at\": \"2023-08-22T23:11:33.485Z\",\n \"modified_at\": \"2017-08-19T12:50:37.782Z\",\n \"name\": \"aliqua enim amet nulla\",\n \"user_count\": -83939923\n },\n \"id\": \"consectetur non magna\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"amet nisi in\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"in consequat deserunt nisi\",\n \"type\": \"permissions\"\n }\n ]\n }\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": 78520069,\n \"total_filtered_count\": 88420530\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Grant role to an archive",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id",
"value": "pariatur consequat"
}
]
},
"description": "Adds a read role to an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Revoke role from an archive",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id",
"value": "pariatur consequat"
}
]
},
"description": "Removes a role from an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id/readers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives",
":archive_id",
"readers"
],
"variable": [
{
"key": "archive_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get archive order",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archive-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archive-order"
]
},
"description": "Get the current order of your archives.\nThis endpoint takes no JSON arguments."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archive-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archive-order"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"archive_order\",\n \"attributes\": {\n \"archive_ids\": [\n \"a2zcMylnM4OCHpYusxIi1g\",\n \"a2zcMylnM4OCHpYusxIi2g\",\n \"a2zcMylnM4OCHpYusxIi3g\"\n ]\n }\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archive-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archive-order"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archive-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archive-order"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update archive order",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archive_order\",\n \"attributes\": {\n \"archive_ids\": [\n \"a2zcMylnM4OCHpYusxIi1g\",\n \"a2zcMylnM4OCHpYusxIi2g\",\n \"a2zcMylnM4OCHpYusxIi3g\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archive-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archive-order"
]
},
"description": "Update the order of your archives. Since logs are processed sequentially, reordering an archive may change\nthe structure and content of the data processed by other archives.\n\n**Note**: Using the `PUT` method updates your archive's order by replacing the current order\nwith the new one."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archive_order\",\n \"attributes\": {\n \"archive_ids\": [\n \"a2zcMylnM4OCHpYusxIi1g\",\n \"a2zcMylnM4OCHpYusxIi2g\",\n \"a2zcMylnM4OCHpYusxIi3g\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archive-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archive-order"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"archive_order\",\n \"attributes\": {\n \"archive_ids\": [\n \"a2zcMylnM4OCHpYusxIi1g\",\n \"a2zcMylnM4OCHpYusxIi2g\",\n \"a2zcMylnM4OCHpYusxIi3g\"\n ]\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archive_order\",\n \"attributes\": {\n \"archive_ids\": [\n \"a2zcMylnM4OCHpYusxIi1g\",\n \"a2zcMylnM4OCHpYusxIi2g\",\n \"a2zcMylnM4OCHpYusxIi3g\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archive-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archive-order"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archive_order\",\n \"attributes\": {\n \"archive_ids\": [\n \"a2zcMylnM4OCHpYusxIi1g\",\n \"a2zcMylnM4OCHpYusxIi2g\",\n \"a2zcMylnM4OCHpYusxIi3g\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archive-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archive-order"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unprocessable Entity",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archive_order\",\n \"attributes\": {\n \"archive_ids\": [\n \"a2zcMylnM4OCHpYusxIi1g\",\n \"a2zcMylnM4OCHpYusxIi2g\",\n \"a2zcMylnM4OCHpYusxIi3g\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archive-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archive-order"
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archive_order\",\n \"attributes\": {\n \"archive_ids\": [\n \"a2zcMylnM4OCHpYusxIi1g\",\n \"a2zcMylnM4OCHpYusxIi2g\",\n \"a2zcMylnM4OCHpYusxIi3g\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archive-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archive-order"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Archives forward all the logs ingested to a cloud storage system.\n\nSee the [Archives Page](https://app.datadoghq.com/logs/pipelines/archives) \nfor a list of the archives currently configured in Datadog.\n\nYou need an API and non-scoped application key with Admin rights to interact with these endpoints.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Logs Custom Destinations",
"item": [
{
"name": "Get all custom destinations",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations"
]
},
"description": "Get the list of configured custom destinations in your organization with their definitions."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\"\n }\n },\n \"name\": \"Nginx logs\",\n \"query\": \"source:nginx\"\n },\n \"id\": \"be5d7a69-d0c8-4d4d-8ee8-bba292d98139\",\n \"type\": \"custom_destination\"\n },\n {\n \"attributes\": {\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\"\n }\n },\n \"name\": \"Nginx logs\",\n \"query\": \"source:nginx\"\n },\n \"id\": \"be5d7a69-d0c8-4d4d-8ee8-bba292d98139\",\n \"type\": \"custom_destination\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a custom destination",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_destination\",\n \"attributes\": {\n \"name\": \"Nginx logs\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\",\n \"username\": \"datadog-custom-destination-username\",\n \"password\": \"datadog-custom-destination-password\"\n }\n },\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"query\": \"source:nginx\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations"
]
},
"description": "Create a custom destination in your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_destination\",\n \"attributes\": {\n \"name\": \"Nginx logs\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\",\n \"username\": \"datadog-custom-destination-username\",\n \"password\": \"datadog-custom-destination-password\"\n }\n },\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"query\": \"source:nginx\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\"\n }\n },\n \"name\": \"Nginx logs\",\n \"query\": \"source:nginx\"\n },\n \"id\": \"be5d7a69-d0c8-4d4d-8ee8-bba292d98139\",\n \"type\": \"custom_destination\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_destination\",\n \"attributes\": {\n \"name\": \"Nginx logs\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\",\n \"username\": \"datadog-custom-destination-username\",\n \"password\": \"datadog-custom-destination-password\"\n }\n },\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"query\": \"source:nginx\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_destination\",\n \"attributes\": {\n \"name\": \"Nginx logs\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\",\n \"username\": \"datadog-custom-destination-username\",\n \"password\": \"datadog-custom-destination-password\"\n }\n },\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"query\": \"source:nginx\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_destination\",\n \"attributes\": {\n \"name\": \"Nginx logs\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\",\n \"username\": \"datadog-custom-destination-username\",\n \"password\": \"datadog-custom-destination-password\"\n }\n },\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"query\": \"source:nginx\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_destination\",\n \"attributes\": {\n \"name\": \"Nginx logs\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\",\n \"username\": \"datadog-custom-destination-username\",\n \"password\": \"datadog-custom-destination-password\"\n }\n },\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"query\": \"source:nginx\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a custom destination",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id",
"value": "pariatur consequat"
}
]
},
"description": "Get a specific custom destination in your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\"\n }\n },\n \"name\": \"Nginx logs\",\n \"query\": \"source:nginx\"\n },\n \"id\": \"be5d7a69-d0c8-4d4d-8ee8-bba292d98139\",\n \"type\": \"custom_destination\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a custom destination",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_destination\",\n \"id\": \"be5d7a69-d0c8-4d4d-8ee8-bba292d98139\",\n \"attributes\": {\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\",\n \"username\": \"datadog-custom-destination-username\",\n \"password\": \"datadog-custom-destination-password\"\n }\n },\n \"name\": \"Nginx logs\",\n \"query\": \"source:nginx\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id",
"value": "pariatur consequat"
}
]
},
"description": "Update the given fields of a specific custom destination in your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_destination\",\n \"id\": \"be5d7a69-d0c8-4d4d-8ee8-bba292d98139\",\n \"attributes\": {\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\",\n \"username\": \"datadog-custom-destination-username\",\n \"password\": \"datadog-custom-destination-password\"\n }\n },\n \"name\": \"Nginx logs\",\n \"query\": \"source:nginx\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\"\n }\n },\n \"name\": \"Nginx logs\",\n \"query\": \"source:nginx\"\n },\n \"id\": \"be5d7a69-d0c8-4d4d-8ee8-bba292d98139\",\n \"type\": \"custom_destination\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_destination\",\n \"id\": \"be5d7a69-d0c8-4d4d-8ee8-bba292d98139\",\n \"attributes\": {\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\",\n \"username\": \"datadog-custom-destination-username\",\n \"password\": \"datadog-custom-destination-password\"\n }\n },\n \"name\": \"Nginx logs\",\n \"query\": \"source:nginx\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_destination\",\n \"id\": \"be5d7a69-d0c8-4d4d-8ee8-bba292d98139\",\n \"attributes\": {\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\",\n \"username\": \"datadog-custom-destination-username\",\n \"password\": \"datadog-custom-destination-password\"\n }\n },\n \"name\": \"Nginx logs\",\n \"query\": \"source:nginx\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_destination\",\n \"id\": \"be5d7a69-d0c8-4d4d-8ee8-bba292d98139\",\n \"attributes\": {\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\",\n \"username\": \"datadog-custom-destination-username\",\n \"password\": \"datadog-custom-destination-password\"\n }\n },\n \"name\": \"Nginx logs\",\n \"query\": \"source:nginx\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_destination\",\n \"id\": \"be5d7a69-d0c8-4d4d-8ee8-bba292d98139\",\n \"attributes\": {\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\",\n \"username\": \"datadog-custom-destination-username\",\n \"password\": \"datadog-custom-destination-password\"\n }\n },\n \"name\": \"Nginx logs\",\n \"query\": \"source:nginx\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_destination\",\n \"id\": \"be5d7a69-d0c8-4d4d-8ee8-bba292d98139\",\n \"attributes\": {\n \"enabled\": true,\n \"forward_tags\": true,\n \"forward_tags_restriction_list\": [\n \"datacenter\",\n \"host\"\n ],\n \"forward_tags_restriction_list_type\": \"ALLOW_LIST\",\n \"forwarder_destination\": {\n \"type\": \"http\",\n \"endpoint\": \"https://example.com\",\n \"auth\": {\n \"type\": \"basic\",\n \"username\": \"datadog-custom-destination-username\",\n \"password\": \"datadog-custom-destination-password\"\n }\n },\n \"name\": \"Nginx logs\",\n \"query\": \"source:nginx\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a custom destination",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete a specific custom destination in your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/custom-destinations/:custom_destination_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"custom-destinations",
":custom_destination_id"
],
"variable": [
{
"key": "custom_destination_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Custom Destinations forward all the logs ingested to an external destination.\n\nSee the [Custom Destinations Page](https://app.datadoghq.com/logs/pipelines/log-forwarding/custom-destinations)\nfor a list of the custom destinations currently configured in web UI.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Logs Indexes",
"item": [
{
"name": "Get all indexes",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes"
]
},
"description": "The Index object describes the configuration of a log index.\nThis endpoint returns an array of the `LogIndex` objects of your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"indexes\": [\n {\n \"name\": \"main\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"daily_limit_reset\": {\n \"reset_time\": \"14:00\",\n \"reset_utc_offset\": \"+02:00\"\n },\n \"daily_limit_warning_threshold_percentage\": 70,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n }\n ],\n \"is_rate_limited\": false,\n \"num_flex_logs_retention_days\": 360,\n \"num_retention_days\": 15\n },\n {\n \"name\": \"main\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"daily_limit_reset\": {\n \"reset_time\": \"14:00\",\n \"reset_utc_offset\": \"+02:00\"\n },\n \"daily_limit_warning_threshold_percentage\": 70,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n }\n ],\n \"is_rate_limited\": false,\n \"num_flex_logs_retention_days\": 360,\n \"num_retention_days\": 15\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get an index",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name",
"value": "dolor veniam nostrud cillum"
}
]
},
"description": "Get one log index from your organization. This endpoint takes no JSON arguments."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"main\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"daily_limit_reset\": {\n \"reset_time\": \"14:00\",\n \"reset_utc_offset\": \"+02:00\"\n },\n \"daily_limit_warning_threshold_percentage\": 70,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n }\n ],\n \"is_rate_limited\": false,\n \"num_flex_logs_retention_days\": 360,\n \"num_retention_days\": 15\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "null"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create an index",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"main\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"daily_limit_reset\": {\n \"reset_time\": \"14:00\",\n \"reset_utc_offset\": \"+02:00\"\n },\n \"daily_limit_warning_threshold_percentage\": 70,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n }\n ],\n \"is_rate_limited\": false,\n \"num_flex_logs_retention_days\": 360,\n \"num_retention_days\": 15\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes"
]
},
"description": "Creates a new index. Returns the Index object passed in the request body when the request is successful."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"main\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"daily_limit_reset\": {\n \"reset_time\": \"14:00\",\n \"reset_utc_offset\": \"+02:00\"\n },\n \"daily_limit_warning_threshold_percentage\": 70,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n }\n ],\n \"is_rate_limited\": false,\n \"num_flex_logs_retention_days\": 360,\n \"num_retention_days\": 15\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"main\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"daily_limit_reset\": {\n \"reset_time\": \"14:00\",\n \"reset_utc_offset\": \"+02:00\"\n },\n \"daily_limit_warning_threshold_percentage\": 70,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n }\n ],\n \"is_rate_limited\": false,\n \"num_flex_logs_retention_days\": 360,\n \"num_retention_days\": 15\n}"
},
{
"name": "Invalid Parameter Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"main\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"daily_limit_reset\": {\n \"reset_time\": \"14:00\",\n \"reset_utc_offset\": \"+02:00\"\n },\n \"daily_limit_warning_threshold_percentage\": 70,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n }\n ],\n \"is_rate_limited\": false,\n \"num_flex_logs_retention_days\": 360,\n \"num_retention_days\": 15\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "null"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"main\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"daily_limit_reset\": {\n \"reset_time\": \"14:00\",\n \"reset_utc_offset\": \"+02:00\"\n },\n \"daily_limit_warning_threshold_percentage\": 70,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n }\n ],\n \"is_rate_limited\": false,\n \"num_flex_logs_retention_days\": 360,\n \"num_retention_days\": 15\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"main\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"daily_limit_reset\": {\n \"reset_time\": \"14:00\",\n \"reset_utc_offset\": \"+02:00\"\n },\n \"daily_limit_warning_threshold_percentage\": 70,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n }\n ],\n \"is_rate_limited\": false,\n \"num_flex_logs_retention_days\": 360,\n \"num_retention_days\": 15\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update an index",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"daily_limit_reset\": {\n \"reset_time\": \"14:00\",\n \"reset_utc_offset\": \"+02:00\"\n },\n \"daily_limit_warning_threshold_percentage\": 70,\n \"disable_daily_limit\": false,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n }\n ],\n \"num_flex_logs_retention_days\": 360,\n \"num_retention_days\": 15\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name",
"value": "dolor veniam nostrud cillum"
}
]
},
"description": "Update an index as identified by its name.\nReturns the Index object passed in the request body when the request is successful.\n\nUsing the `PUT` method updates your index’s configuration by **replacing**\nyour current configuration with the new one sent to your Datadog organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"daily_limit_reset\": {\n \"reset_time\": \"14:00\",\n \"reset_utc_offset\": \"+02:00\"\n },\n \"daily_limit_warning_threshold_percentage\": 70,\n \"disable_daily_limit\": false,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n }\n ],\n \"num_flex_logs_retention_days\": 360,\n \"num_retention_days\": 15\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"main\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"daily_limit_reset\": {\n \"reset_time\": \"14:00\",\n \"reset_utc_offset\": \"+02:00\"\n },\n \"daily_limit_warning_threshold_percentage\": 70,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n }\n ],\n \"is_rate_limited\": false,\n \"num_flex_logs_retention_days\": 360,\n \"num_retention_days\": 15\n}"
},
{
"name": "Invalid Parameter Error",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"daily_limit_reset\": {\n \"reset_time\": \"14:00\",\n \"reset_utc_offset\": \"+02:00\"\n },\n \"daily_limit_warning_threshold_percentage\": 70,\n \"disable_daily_limit\": false,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n }\n ],\n \"num_flex_logs_retention_days\": 360,\n \"num_retention_days\": 15\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "null"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"daily_limit_reset\": {\n \"reset_time\": \"14:00\",\n \"reset_utc_offset\": \"+02:00\"\n },\n \"daily_limit_warning_threshold_percentage\": 70,\n \"disable_daily_limit\": false,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n }\n ],\n \"num_flex_logs_retention_days\": 360,\n \"num_retention_days\": 15\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"daily_limit_reset\": {\n \"reset_time\": \"14:00\",\n \"reset_utc_offset\": \"+02:00\"\n },\n \"daily_limit_warning_threshold_percentage\": 70,\n \"disable_daily_limit\": false,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n }\n ],\n \"num_flex_logs_retention_days\": 360,\n \"num_retention_days\": 15\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "null"
}
]
},
{
"name": "Delete an index",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name",
"value": "dolor veniam nostrud cillum"
}
]
},
"description": "Delete an existing index from your organization. Index deletions are permanent and cannot be reverted.\nYou cannot recreate an index with the same name as deleted ones."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "null"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get indexes order",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/index-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"index-order"
]
},
"description": "Get the current order of your log indexes. This endpoint takes no JSON arguments."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/index-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"index-order"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"index_names\": [\n \"main\",\n \"payments\",\n \"web\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/index-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"index-order"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/index-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"index-order"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update indexes order",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"index_names\": [\n \"main\",\n \"payments\",\n \"web\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/index-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"index-order"
]
},
"description": "This endpoint updates the index order of your organization.\nIt returns the index order object passed in the request body when the request is successful."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"index_names\": [\n \"main\",\n \"payments\",\n \"web\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/index-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"index-order"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"index_names\": [\n \"main\",\n \"payments\",\n \"web\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"index_names\": [\n \"main\",\n \"payments\",\n \"web\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/index-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"index-order"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "null"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"index_names\": [\n \"main\",\n \"payments\",\n \"web\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/index-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"index-order"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"index_names\": [\n \"main\",\n \"payments\",\n \"web\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/index-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"index-order"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Manage configuration of [log indexes](https://docs.datadoghq.com/logs/indexes/).",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Logs Metrics",
"item": [
{
"name": "Get all log-based metrics",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics"
]
},
"description": "Get the list of configured log-based metrics with their definitions."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n },\n \"id\": \"logs.page.load.count\",\n \"type\": \"logs_metrics\"\n },\n {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n },\n \"id\": \"logs.page.load.count\",\n \"type\": \"logs_metrics\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a log-based metric",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"logs.page.load.count\",\n \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics"
]
},
"description": "Create a metric based on your ingested logs in your organization.\nReturns the log-based metric object from the request body when the request is successful."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"logs.page.load.count\",\n \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n },\n \"id\": \"logs.page.load.count\",\n \"type\": \"logs_metrics\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"logs.page.load.count\",\n \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"logs.page.load.count\",\n \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"logs.page.load.count\",\n \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"logs.page.load.count\",\n \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a log-based metric",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id",
"value": "pariatur consequat"
}
]
},
"description": "Get a specific log-based metric from your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n },\n \"id\": \"logs.page.load.count\",\n \"type\": \"logs_metrics\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a log-based metric",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": true\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id",
"value": "pariatur consequat"
}
]
},
"description": "Update a specific log-based metric from your organization.\nReturns the log-based metric object from the request body when the request is successful."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": true\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n },\n \"id\": \"logs.page.load.count\",\n \"type\": \"logs_metrics\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": true\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": true\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": true\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": true\n },\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a log-based metric",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete a specific log-based metric from your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Manage configuration of [log-based metrics](https://app.datadoghq.com/logs/pipelines/generate-metrics) for your organization.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Logs Pipelines",
"item": [
{
"name": "Get pipeline order",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipeline-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipeline-order"
]
},
"description": "Get the current order of your pipelines.\nThis endpoint takes no JSON arguments."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipeline-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipeline-order"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"pipeline_ids\": [\n \"tags\",\n \"org_ids\",\n \"products\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipeline-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipeline-order"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipeline-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipeline-order"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update pipeline order",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"pipeline_ids\": [\n \"tags\",\n \"org_ids\",\n \"products\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipeline-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipeline-order"
]
},
"description": "Update the order of your pipelines. Since logs are processed sequentially, reordering a pipeline may change\nthe structure and content of the data processed by other pipelines and their processors.\n\n**Note**: Using the `PUT` method updates your pipeline order by replacing your current order\nwith the new one sent to your Datadog organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"pipeline_ids\": [\n \"tags\",\n \"org_ids\",\n \"products\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipeline-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipeline-order"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"pipeline_ids\": [\n \"tags\",\n \"org_ids\",\n \"products\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"pipeline_ids\": [\n \"tags\",\n \"org_ids\",\n \"products\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipeline-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipeline-order"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "null"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"pipeline_ids\": [\n \"tags\",\n \"org_ids\",\n \"products\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipeline-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipeline-order"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unprocessable Entity",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"pipeline_ids\": [\n \"tags\",\n \"org_ids\",\n \"products\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipeline-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipeline-order"
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "null"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"pipeline_ids\": [\n \"tags\",\n \"org_ids\",\n \"products\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipeline-order",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipeline-order"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all pipelines",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines"
]
},
"description": "Get all pipelines from your organization.\nThis endpoint takes no JSON arguments."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "[\n {\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"incididunt non\",\n \"is_enabled\": false,\n \"is_read_only\": false,\n \"processors\": [\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"cupidatat ex sed\",\n \"samples\": [\n \"id pariatur ut\",\n \"ea eiusmod Duis\"\n ]\n },\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"dolor eiusmod\",\n \"samples\": [\n \"ut reprehenderit nulla Duis\",\n \"elit Duis esse\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n },\n {\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"labore do Lorem cupidatat\",\n \"is_enabled\": false,\n \"is_read_only\": false,\n \"processors\": [\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"culpa velit irure\",\n \"samples\": [\n \"sit consequat dolor pariatur\",\n \"quis occaecat dolor sed\"\n ]\n },\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"id occaecat sint\",\n \"samples\": [\n \"dolor Lorem\",\n \"esse mollit\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n }\n]"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a pipeline",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"\",\n \"is_enabled\": false,\n \"is_read_only\": true,\n \"processors\": [\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"nulla tempor\",\n \"samples\": [\n \"ipsum Duis\",\n \"dolore culpa ea est\"\n ]\n },\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"sunt officia\",\n \"samples\": [\n \"ex ullamco occaecat exercitation\",\n \"esse aute\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines"
]
},
"description": "Create a pipeline in your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"\",\n \"is_enabled\": false,\n \"is_read_only\": true,\n \"processors\": [\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"nulla tempor\",\n \"samples\": [\n \"ipsum Duis\",\n \"dolore culpa ea est\"\n ]\n },\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"sunt officia\",\n \"samples\": [\n \"ex ullamco occaecat exercitation\",\n \"esse aute\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"\",\n \"is_enabled\": false,\n \"is_read_only\": true,\n \"processors\": [\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"nulla tempor\",\n \"samples\": [\n \"ipsum Duis\",\n \"dolore culpa ea est\"\n ]\n },\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"sunt officia\",\n \"samples\": [\n \"ex ullamco occaecat exercitation\",\n \"esse aute\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"\",\n \"is_enabled\": false,\n \"is_read_only\": true,\n \"processors\": [\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"nulla tempor\",\n \"samples\": [\n \"ipsum Duis\",\n \"dolore culpa ea est\"\n ]\n },\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"sunt officia\",\n \"samples\": [\n \"ex ullamco occaecat exercitation\",\n \"esse aute\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "null"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"\",\n \"is_enabled\": false,\n \"is_read_only\": true,\n \"processors\": [\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"nulla tempor\",\n \"samples\": [\n \"ipsum Duis\",\n \"dolore culpa ea est\"\n ]\n },\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"sunt officia\",\n \"samples\": [\n \"ex ullamco occaecat exercitation\",\n \"esse aute\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"\",\n \"is_enabled\": false,\n \"is_read_only\": true,\n \"processors\": [\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"nulla tempor\",\n \"samples\": [\n \"ipsum Duis\",\n \"dolore culpa ea est\"\n ]\n },\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"sunt officia\",\n \"samples\": [\n \"ex ullamco occaecat exercitation\",\n \"esse aute\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a pipeline",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id",
"value": "pariatur"
}
]
},
"description": "Get a specific pipeline from your organization.\nThis endpoint takes no JSON arguments."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"\",\n \"is_enabled\": false,\n \"is_read_only\": true,\n \"processors\": [\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"nulla tempor\",\n \"samples\": [\n \"ipsum Duis\",\n \"dolore culpa ea est\"\n ]\n },\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"sunt officia\",\n \"samples\": [\n \"ex ullamco occaecat exercitation\",\n \"esse aute\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "null"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a pipeline",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id",
"value": "pariatur"
}
]
},
"description": "Delete a given pipeline from your organization.\nThis endpoint takes no JSON arguments."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "null"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a pipeline",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"\",\n \"is_enabled\": false,\n \"is_read_only\": true,\n \"processors\": [\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"nulla tempor\",\n \"samples\": [\n \"ipsum Duis\",\n \"dolore culpa ea est\"\n ]\n },\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"sunt officia\",\n \"samples\": [\n \"ex ullamco occaecat exercitation\",\n \"esse aute\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id",
"value": "pariatur"
}
]
},
"description": "Update a given pipeline configuration to change it’s processors or their order.\n\n**Note**: Using this method updates your pipeline configuration by **replacing**\nyour current configuration with the new one sent to your Datadog organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"\",\n \"is_enabled\": false,\n \"is_read_only\": true,\n \"processors\": [\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"nulla tempor\",\n \"samples\": [\n \"ipsum Duis\",\n \"dolore culpa ea est\"\n ]\n },\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"sunt officia\",\n \"samples\": [\n \"ex ullamco occaecat exercitation\",\n \"esse aute\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"\",\n \"is_enabled\": false,\n \"is_read_only\": true,\n \"processors\": [\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"nulla tempor\",\n \"samples\": [\n \"ipsum Duis\",\n \"dolore culpa ea est\"\n ]\n },\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"sunt officia\",\n \"samples\": [\n \"ex ullamco occaecat exercitation\",\n \"esse aute\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"\",\n \"is_enabled\": false,\n \"is_read_only\": true,\n \"processors\": [\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"nulla tempor\",\n \"samples\": [\n \"ipsum Duis\",\n \"dolore culpa ea est\"\n ]\n },\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"sunt officia\",\n \"samples\": [\n \"ex ullamco occaecat exercitation\",\n \"esse aute\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "null"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"\",\n \"is_enabled\": false,\n \"is_read_only\": true,\n \"processors\": [\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"nulla tempor\",\n \"samples\": [\n \"ipsum Duis\",\n \"dolore culpa ea est\"\n ]\n },\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"sunt officia\",\n \"samples\": [\n \"ex ullamco occaecat exercitation\",\n \"esse aute\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"\",\n \"is_enabled\": false,\n \"is_read_only\": true,\n \"processors\": [\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"nulla tempor\",\n \"samples\": [\n \"ipsum Duis\",\n \"dolore culpa ea est\"\n ]\n },\n {\n \"source\": \"message\",\n \"grok\": {\n \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n },\n \"type\": \"grok-parser\",\n \"is_enabled\": false,\n \"name\": \"sunt officia\",\n \"samples\": [\n \"ex ullamco occaecat exercitation\",\n \"esse aute\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Pipelines and processors operate on incoming logs, parsing\nand transforming them into structured attributes for easier querying.\n\n- See the [pipelines configuration page](https://app.datadoghq.com/logs/pipelines)\n for a list of the pipelines and processors currently configured in web UI.\n\n- Additional API-related information about processors can be found in the\n [processors documentation](https://docs.datadoghq.com/logs/log_configuration/processors/?tab=api#lookup-processor).\n\n- For more information about Pipelines, see the\n [pipeline documentation](https://docs.datadoghq.com/logs/log_configuration/pipelines).\n\n**Notes:**\n\nThese endpoints are only available for admin users.\nMake sure to use an application key created by an admin.\n\n**Grok parsing rules may effect JSON output and require\nreturned data to be configured before using in a request.**\nFor example, if you are using the data returned from a\nrequest for another request body, and have a parsing rule\nthat uses a regex pattern like `\\s` for spaces, you will\nneed to configure all escaped spaces as `%{space}` to use\nin the body data.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Metrics",
"item": [
{
"name": "Create a tag configuration",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"test.metric.latency\",\n \"type\": \"manage_tags\",\n \"attributes\": {\n \"tags\": [\n \"app\",\n \"datacenter\"\n ],\n \"metric_type\": \"count\",\n \"aggregations\": [\n {\n \"space\": \"sum\",\n \"time\": \"sum\"\n },\n {\n \"space\": \"sum\",\n \"time\": \"count\"\n }\n ],\n \"exclude_tags_mode\": true,\n \"include_percentiles\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name",
"value": "dist.http.endpoint.request"
}
]
},
"description": "Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.\nOptionally, include percentile aggregations on any distribution metric. By setting `exclude_tags_mode`\nto true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are\nnot queryable. Can only be used with application keys of users with the `Manage Tags for Metrics`\npermission."
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"test.metric.latency\",\n \"type\": \"manage_tags\",\n \"attributes\": {\n \"tags\": [\n \"app\",\n \"datacenter\"\n ],\n \"metric_type\": \"count\",\n \"aggregations\": [\n {\n \"space\": \"sum\",\n \"time\": \"sum\"\n },\n {\n \"space\": \"sum\",\n \"time\": \"count\"\n }\n ],\n \"exclude_tags_mode\": true,\n \"include_percentiles\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"aggregations\": [\n {\n \"space\": \"avg\",\n \"time\": \"avg\"\n }\n ],\n \"created_at\": \"2020-03-25T09:48:37.463835Z\",\n \"metric_type\": \"gauge\",\n \"modified_at\": \"2020-04-25T09:48:37.463835Z\",\n \"tags\": [\n \"app\",\n \"datacenter\"\n ]\n },\n \"type\": \"manage_tags\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"test.metric.latency\",\n \"type\": \"manage_tags\",\n \"attributes\": {\n \"tags\": [\n \"app\",\n \"datacenter\"\n ],\n \"metric_type\": \"count\",\n \"aggregations\": [\n {\n \"space\": \"sum\",\n \"time\": \"sum\"\n },\n {\n \"space\": \"sum\",\n \"time\": \"count\"\n }\n ],\n \"exclude_tags_mode\": true,\n \"include_percentiles\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"test.metric.latency\",\n \"type\": \"manage_tags\",\n \"attributes\": {\n \"tags\": [\n \"app\",\n \"datacenter\"\n ],\n \"metric_type\": \"count\",\n \"aggregations\": [\n {\n \"space\": \"sum\",\n \"time\": \"sum\"\n },\n {\n \"space\": \"sum\",\n \"time\": \"count\"\n }\n ],\n \"exclude_tags_mode\": true,\n \"include_percentiles\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"test.metric.latency\",\n \"type\": \"manage_tags\",\n \"attributes\": {\n \"tags\": [\n \"app\",\n \"datacenter\"\n ],\n \"metric_type\": \"count\",\n \"aggregations\": [\n {\n \"space\": \"sum\",\n \"time\": \"sum\"\n },\n {\n \"space\": \"sum\",\n \"time\": \"count\"\n }\n ],\n \"exclude_tags_mode\": true,\n \"include_percentiles\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"test.metric.latency\",\n \"type\": \"manage_tags\",\n \"attributes\": {\n \"tags\": [\n \"app\",\n \"datacenter\"\n ],\n \"metric_type\": \"count\",\n \"aggregations\": [\n {\n \"space\": \"sum\",\n \"time\": \"sum\"\n },\n {\n \"space\": \"sum\",\n \"time\": \"count\"\n }\n ],\n \"exclude_tags_mode\": true,\n \"include_percentiles\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get active metrics list",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/metrics?from=10554192&host=sit esse&tag_filter=env IN (staging,test) AND service:web",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics"
],
"query": [
{
"key": "from",
"value": "10554192",
"description": "(Required) Seconds since the Unix epoch."
},
{
"key": "host",
"value": "sit esse",
"description": "Hostname for filtering the list of metrics returned.\nIf set, metrics retrieved are those with the corresponding hostname tag."
},
{
"key": "tag_filter",
"value": "env IN (staging,test) AND service:web",
"description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCannot be combined with other filters."
}
]
},
"description": "Get the list of actively reporting metrics from a given time until now."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/metrics?from=10554192&host=sit esse&tag_filter=env IN (staging,test) AND service:web",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics"
],
"query": [
{
"key": "from",
"value": "10554192",
"description": "(Required) Seconds since the Unix epoch."
},
{
"key": "host",
"value": "sit esse",
"description": "Hostname for filtering the list of metrics returned.\nIf set, metrics retrieved are those with the corresponding hostname tag."
},
{
"key": "tag_filter",
"value": "env IN (staging,test) AND service:web",
"description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCannot be combined with other filters."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"from\": \"et nisi ut\",\n \"metrics\": [\n \"ut Excepteur nostrud\",\n \"ex anim ea\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/metrics?from=10554192&host=sit esse&tag_filter=env IN (staging,test) AND service:web",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics"
],
"query": [
{
"key": "from",
"value": "10554192",
"description": "(Required) Seconds since the Unix epoch."
},
{
"key": "host",
"value": "sit esse",
"description": "Hostname for filtering the list of metrics returned.\nIf set, metrics retrieved are those with the corresponding hostname tag."
},
{
"key": "tag_filter",
"value": "env IN (staging,test) AND service:web",
"description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCannot be combined with other filters."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/metrics?from=10554192&host=sit esse&tag_filter=env IN (staging,test) AND service:web",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics"
],
"query": [
{
"key": "from",
"value": "10554192",
"description": "(Required) Seconds since the Unix epoch."
},
{
"key": "host",
"value": "sit esse",
"description": "Hostname for filtering the list of metrics returned.\nIf set, metrics retrieved are those with the corresponding hostname tag."
},
{
"key": "tag_filter",
"value": "env IN (staging,test) AND service:web",
"description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCannot be combined with other filters."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/metrics?from=10554192&host=sit esse&tag_filter=env IN (staging,test) AND service:web",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics"
],
"query": [
{
"key": "from",
"value": "10554192",
"description": "(Required) Seconds since the Unix epoch."
},
{
"key": "host",
"value": "sit esse",
"description": "Hostname for filtering the list of metrics returned.\nIf set, metrics retrieved are those with the corresponding hostname tag."
},
{
"key": "tag_filter",
"value": "env IN (staging,test) AND service:web",
"description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCannot be combined with other filters."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Query timeseries data across multiple products",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": 1568923200000,\n \"from\": 1568899800000,\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"avg:system.cpu.user{*} by {env}\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": 5000\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
},
"description": "Query timeseries data across various data sources and\nprocess the data by applying formulas and functions."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": 1568923200000,\n \"from\": 1568899800000,\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"avg:system.cpu.user{*} by {env}\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": 5000\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"series\": [\n {\n \"group_tags\": [\n \"env:production\",\n \"env:production\"\n ],\n \"query_index\": 0,\n \"unit\": [\n {\n \"family\": \"time\",\n \"name\": \"minute\",\n \"plural\": \"minutes\",\n \"scale_factor\": 60,\n \"short_name\": \"min\"\n },\n {\n \"family\": \"time\",\n \"name\": \"minute\",\n \"plural\": \"minutes\",\n \"scale_factor\": 60,\n \"short_name\": \"min\"\n }\n ]\n },\n {\n \"group_tags\": [\n \"env:production\",\n \"env:production\"\n ],\n \"query_index\": 0,\n \"unit\": [\n {\n \"family\": \"time\",\n \"name\": \"minute\",\n \"plural\": \"minutes\",\n \"scale_factor\": 60,\n \"short_name\": \"min\"\n },\n {\n \"family\": \"time\",\n \"name\": \"minute\",\n \"plural\": \"minutes\",\n \"scale_factor\": 60,\n \"short_name\": \"min\"\n }\n ]\n }\n ],\n \"times\": [\n 1568899800000,\n 1568899800000\n ],\n \"values\": [\n [\n 1575317847,\n 0.5\n ],\n [\n 1575317847,\n 0.5\n ]\n ]\n },\n \"type\": \"timeseries_response\"\n },\n \"errors\": \"veniam amet minim voluptate\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": 1568923200000,\n \"from\": 1568899800000,\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"avg:system.cpu.user{*} by {env}\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": 5000\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": 1568923200000,\n \"from\": 1568899800000,\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"avg:system.cpu.user{*} by {env}\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": 5000\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": 1568923200000,\n \"from\": 1568899800000,\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"avg:system.cpu.user{*} by {env}\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": 5000\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": 1568923200000,\n \"from\": 1568899800000,\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"avg:system.cpu.user{*} by {env}\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": 5000\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Submit distribution points",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "identity",
"description": "HTTP header used to compress the media-type."
},
{
"key": "Content-Type",
"value": "text/json"
},
{
"key": "Accept",
"value": "text/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"series\": [\n {\n \"metric\": \"system.load.1.dist\",\n \"points\": [\n [\n 1636629071,\n [\n 1.0,\n 2.0\n ]\n ]\n ]\n }\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/distribution_points",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"distribution_points"
]
},
"description": "The distribution points end-point allows you to post distribution data that can be graphed on Datadog’s dashboards."
},
"response": [
{
"name": "Payload accepted",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "deflate",
"description": "HTTP header used to compress the media-type."
},
{
"key": "Content-Type",
"value": "text/json"
},
{
"key": "Accept",
"value": "text/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n \"externalValue\": \"examples/metrics/distribution-points.json.sh\",\n \"summary\": \"Dynamic Points\",\n \"x-variables\": {\n \"NOW\": \"$(date +%s)\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/distribution_points",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"distribution_points"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/json"
}
],
"cookie": [],
"body": "{\n \"status\": \"ok\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "deflate",
"description": "HTTP header used to compress the media-type."
},
{
"key": "Content-Type",
"value": "text/json"
},
{
"key": "Accept",
"value": "text/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n \"externalValue\": \"examples/metrics/distribution-points.json.sh\",\n \"summary\": \"Dynamic Points\",\n \"x-variables\": {\n \"NOW\": \"$(date +%s)\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/distribution_points",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"distribution_points"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "deflate",
"description": "HTTP header used to compress the media-type."
},
{
"key": "Content-Type",
"value": "text/json"
},
{
"key": "Accept",
"value": "text/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n \"externalValue\": \"examples/metrics/distribution-points.json.sh\",\n \"summary\": \"Dynamic Points\",\n \"x-variables\": {\n \"NOW\": \"$(date +%s)\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/distribution_points",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"distribution_points"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Request timeout",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "deflate",
"description": "HTTP header used to compress the media-type."
},
{
"key": "Content-Type",
"value": "text/json"
},
{
"key": "Accept",
"value": "text/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n \"externalValue\": \"examples/metrics/distribution-points.json.sh\",\n \"summary\": \"Dynamic Points\",\n \"x-variables\": {\n \"NOW\": \"$(date +%s)\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/distribution_points",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"distribution_points"
]
}
},
"status": "Request Timeout",
"code": 408,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Payload too large",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "deflate",
"description": "HTTP header used to compress the media-type."
},
{
"key": "Content-Type",
"value": "text/json"
},
{
"key": "Accept",
"value": "text/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n \"externalValue\": \"examples/metrics/distribution-points.json.sh\",\n \"summary\": \"Dynamic Points\",\n \"x-variables\": {\n \"NOW\": \"$(date +%s)\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/distribution_points",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"distribution_points"
]
}
},
"status": "Request Entity Too Large",
"code": 413,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "deflate",
"description": "HTTP header used to compress the media-type."
},
{
"key": "Content-Type",
"value": "text/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n \"externalValue\": \"examples/metrics/distribution-points.json.sh\",\n \"summary\": \"Dynamic Points\",\n \"x-variables\": {\n \"NOW\": \"$(date +%s)\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/distribution_points",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"distribution_points"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Submit metrics",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "identity",
"description": "HTTP header used to compress the media-type."
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"series\": [\n {\n \"metric\": \"<string>\",\n \"points\": [\n {\n \"timestamp\": \"<long>\",\n \"value\": \"<double>\"\n },\n {\n \"timestamp\": \"<long>\",\n \"value\": \"<double>\"\n }\n ],\n \"interval\": \"<long>\",\n \"metadata\": {\n \"origin\": {\n \"metric_type\": 0,\n \"product\": 0,\n \"service\": 0\n }\n },\n \"resources\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"source_type_name\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"type\": 3,\n \"unit\": \"<string>\"\n },\n {\n \"metric\": \"<string>\",\n \"points\": [\n {\n \"timestamp\": \"<long>\",\n \"value\": \"<double>\"\n },\n {\n \"timestamp\": \"<long>\",\n \"value\": \"<double>\"\n }\n ],\n \"interval\": \"<long>\",\n \"metadata\": {\n \"origin\": {\n \"metric_type\": 0,\n \"product\": 0,\n \"service\": 0\n }\n },\n \"resources\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"source_type_name\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"type\": 0,\n \"unit\": \"<string>\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/series",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"series"
]
},
"description": "The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards.\nThe maximum payload size is 500 kilobytes (512000 bytes). Compressed payloads must have a decompressed size of less than 5 megabytes (5242880 bytes).\n\nIf you’re submitting metrics directly to the Datadog API without using DogStatsD, expect:\n\n- 64 bits for the timestamp\n- 64 bits for the value\n- 20 bytes for the metric names\n- 50 bytes for the timeseries\n- The full payload is approximately 100 bytes.\n\nHost name is one of the resources in the Resources field."
},
"response": [
{
"name": "Payload accepted",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "deflate",
"description": "HTTP header used to compress the media-type."
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n \"externalValue\": \"examples/metrics/dynamic-points.json.sh\",\n \"summary\": \"Dynamic Points\",\n \"x-variables\": {\n \"NOW\": \"$(date +%s)\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/series",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"series"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"magna ea ad\",\n \"in eiusmod\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "deflate",
"description": "HTTP header used to compress the media-type."
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n \"externalValue\": \"examples/metrics/dynamic-points.json.sh\",\n \"summary\": \"Dynamic Points\",\n \"x-variables\": {\n \"NOW\": \"$(date +%s)\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/series",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"series"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "deflate",
"description": "HTTP header used to compress the media-type."
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n \"externalValue\": \"examples/metrics/dynamic-points.json.sh\",\n \"summary\": \"Dynamic Points\",\n \"x-variables\": {\n \"NOW\": \"$(date +%s)\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/series",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"series"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Request timeout",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "deflate",
"description": "HTTP header used to compress the media-type."
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n \"externalValue\": \"examples/metrics/dynamic-points.json.sh\",\n \"summary\": \"Dynamic Points\",\n \"x-variables\": {\n \"NOW\": \"$(date +%s)\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/series",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"series"
]
}
},
"status": "Request Timeout",
"code": 408,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Payload too large",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "deflate",
"description": "HTTP header used to compress the media-type."
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n \"externalValue\": \"examples/metrics/dynamic-points.json.sh\",\n \"summary\": \"Dynamic Points\",\n \"x-variables\": {\n \"NOW\": \"$(date +%s)\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/series",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"series"
]
}
},
"status": "Request Entity Too Large",
"code": 413,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Encoding",
"value": "deflate",
"description": "HTTP header used to compress the media-type."
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n \"externalValue\": \"examples/metrics/dynamic-points.json.sh\",\n \"summary\": \"Dynamic Points\",\n \"x-variables\": {\n \"NOW\": \"$(date +%s)\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/series",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"series"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get metric metadata",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name",
"value": "sit esse"
}
]
},
"description": "Get metadata about a specific metric."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"description\": \"tempor ea est anim\",\n \"integration\": \"\",\n \"per_unit\": \"second\",\n \"short_name\": \"anim \",\n \"statsd_interval\": -30838513,\n \"type\": \"count\",\n \"unit\": \"byte\"\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List tag configuration by name",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name",
"value": "dist.http.endpoint.request"
}
]
},
"description": "Returns the tag configuration for the given metric name."
},
"response": [
{
"name": "Success",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"aggregations\": [\n {\n \"space\": \"avg\",\n \"time\": \"avg\"\n }\n ],\n \"created_at\": \"2020-03-25T09:48:37.463835Z\",\n \"metric_type\": \"gauge\",\n \"modified_at\": \"2020-04-25T09:48:37.463835Z\",\n \"tags\": [\n \"app\",\n \"datacenter\"\n ]\n },\n \"type\": \"manage_tags\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Query scalar data across multiple products",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"scalar_request\",\n \"attributes\": {\n \"to\": 1568923200000,\n \"from\": 1568899800000,\n \"queries\": [\n {\n \"aggregator\": \"avg\",\n \"data_source\": \"metrics\",\n \"query\": \"avg:system.cpu.user{*} by {env}\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/scalar",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"scalar"
]
},
"description": "Query scalar values (as seen on Query Value, Table, and Toplist widgets).\nMultiple data sources are supported with the ability to\nprocess the data using formulas and functions."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"scalar_request\",\n \"attributes\": {\n \"to\": 1568923200000,\n \"from\": 1568899800000,\n \"queries\": [\n {\n \"aggregator\": \"avg\",\n \"data_source\": \"metrics\",\n \"query\": \"avg:system.cpu.user{*} by {env}\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/scalar",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"scalar"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"columns\": [\n {\n \"name\": \"env\",\n \"type\": \"group\",\n \"values\": [\n [\n \"production\"\n ],\n [\n \"staging\"\n ]\n ]\n },\n {\n \"name\": \"env\",\n \"type\": \"group\",\n \"values\": [\n [\n \"production\"\n ],\n [\n \"staging\"\n ]\n ]\n }\n ]\n },\n \"type\": \"scalar_response\"\n },\n \"errors\": \"magna ex eu\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"scalar_request\",\n \"attributes\": {\n \"to\": 1568923200000,\n \"from\": 1568899800000,\n \"queries\": [\n {\n \"aggregator\": \"avg\",\n \"data_source\": \"metrics\",\n \"query\": \"avg:system.cpu.user{*} by {env}\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/scalar",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"scalar"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"scalar_request\",\n \"attributes\": {\n \"to\": 1568923200000,\n \"from\": 1568899800000,\n \"queries\": [\n {\n \"aggregator\": \"avg\",\n \"data_source\": \"metrics\",\n \"query\": \"avg:system.cpu.user{*} by {env}\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/scalar",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"scalar"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"scalar_request\",\n \"attributes\": {\n \"to\": 1568923200000,\n \"from\": 1568899800000,\n \"queries\": [\n {\n \"aggregator\": \"avg\",\n \"data_source\": \"metrics\",\n \"query\": \"avg:system.cpu.user{*} by {env}\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/scalar",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"scalar"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"scalar_request\",\n \"attributes\": {\n \"to\": 1568923200000,\n \"from\": 1568899800000,\n \"queries\": [\n {\n \"aggregator\": \"avg\",\n \"data_source\": \"metrics\",\n \"query\": \"avg:system.cpu.user{*} by {env}\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"a+b\",\n \"limit\": {\n \"count\": 10,\n \"order\": \"desc\"\n }\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/scalar",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"scalar"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Edit metric metadata",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"tempor ea est anim\",\n \"integration\": \"\",\n \"per_unit\": \"second\",\n \"short_name\": \"anim \",\n \"statsd_interval\": -30838513,\n \"type\": \"count\",\n \"unit\": \"byte\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name",
"value": "sit esse"
}
]
},
"description": "Edit metadata of a specific metric. Find out more about [supported types](https://docs.datadoghq.com/developers/metrics)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"tempor ea est anim\",\n \"integration\": \"\",\n \"per_unit\": \"second\",\n \"short_name\": \"anim \",\n \"statsd_interval\": -30838513,\n \"type\": \"count\",\n \"unit\": \"byte\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"description\": \"tempor ea est anim\",\n \"integration\": \"\",\n \"per_unit\": \"second\",\n \"short_name\": \"anim \",\n \"statsd_interval\": -30838513,\n \"type\": \"count\",\n \"unit\": \"byte\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"tempor ea est anim\",\n \"integration\": \"\",\n \"per_unit\": \"second\",\n \"short_name\": \"anim \",\n \"statsd_interval\": -30838513,\n \"type\": \"count\",\n \"unit\": \"byte\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"tempor ea est anim\",\n \"integration\": \"\",\n \"per_unit\": \"second\",\n \"short_name\": \"anim \",\n \"statsd_interval\": -30838513,\n \"type\": \"count\",\n \"unit\": \"byte\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"tempor ea est anim\",\n \"integration\": \"\",\n \"per_unit\": \"second\",\n \"short_name\": \"anim \",\n \"statsd_interval\": -30838513,\n \"type\": \"count\",\n \"unit\": \"byte\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"tempor ea est anim\",\n \"integration\": \"\",\n \"per_unit\": \"second\",\n \"short_name\": \"anim \",\n \"statsd_interval\": -30838513,\n \"type\": \"count\",\n \"unit\": \"byte\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a tag configuration",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"test.metric.latency\",\n \"type\": \"manage_tags\",\n \"attributes\": {\n \"aggregations\": [\n {\n \"space\": \"sum\",\n \"time\": \"sum\"\n },\n {\n \"space\": \"sum\",\n \"time\": \"count\"\n }\n ],\n \"exclude_tags_mode\": false,\n \"include_percentiles\": true,\n \"tags\": [\n \"app\",\n \"datacenter\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name",
"value": "dist.http.endpoint.request"
}
]
},
"description": "Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations\nof a count, rate, or gauge metric. By setting `exclude_tags_mode` to true the behavior is changed\nfrom an allow-list to a deny-list, and tags in the defined list will not be queryable.\nCan only be used with application keys from users with the `Manage Tags for Metrics` permission. This endpoint requires\na tag configuration to be created first."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"test.metric.latency\",\n \"type\": \"manage_tags\",\n \"attributes\": {\n \"aggregations\": [\n {\n \"space\": \"sum\",\n \"time\": \"sum\"\n },\n {\n \"space\": \"sum\",\n \"time\": \"count\"\n }\n ],\n \"exclude_tags_mode\": false,\n \"include_percentiles\": true,\n \"tags\": [\n \"app\",\n \"datacenter\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"aggregations\": [\n {\n \"space\": \"avg\",\n \"time\": \"avg\"\n }\n ],\n \"created_at\": \"2020-03-25T09:48:37.463835Z\",\n \"metric_type\": \"gauge\",\n \"modified_at\": \"2020-04-25T09:48:37.463835Z\",\n \"tags\": [\n \"app\",\n \"datacenter\"\n ]\n },\n \"type\": \"manage_tags\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"test.metric.latency\",\n \"type\": \"manage_tags\",\n \"attributes\": {\n \"aggregations\": [\n {\n \"space\": \"sum\",\n \"time\": \"sum\"\n },\n {\n \"space\": \"sum\",\n \"time\": \"count\"\n }\n ],\n \"exclude_tags_mode\": false,\n \"include_percentiles\": true,\n \"tags\": [\n \"app\",\n \"datacenter\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"test.metric.latency\",\n \"type\": \"manage_tags\",\n \"attributes\": {\n \"aggregations\": [\n {\n \"space\": \"sum\",\n \"time\": \"sum\"\n },\n {\n \"space\": \"sum\",\n \"time\": \"count\"\n }\n ],\n \"exclude_tags_mode\": false,\n \"include_percentiles\": true,\n \"tags\": [\n \"app\",\n \"datacenter\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unprocessable Entity",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"test.metric.latency\",\n \"type\": \"manage_tags\",\n \"attributes\": {\n \"aggregations\": [\n {\n \"space\": \"sum\",\n \"time\": \"sum\"\n },\n {\n \"space\": \"sum\",\n \"time\": \"count\"\n }\n ],\n \"exclude_tags_mode\": false,\n \"include_percentiles\": true,\n \"tags\": [\n \"app\",\n \"datacenter\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"test.metric.latency\",\n \"type\": \"manage_tags\",\n \"attributes\": {\n \"aggregations\": [\n {\n \"space\": \"sum\",\n \"time\": \"sum\"\n },\n {\n \"space\": \"sum\",\n \"time\": \"count\"\n }\n ],\n \"exclude_tags_mode\": false,\n \"include_percentiles\": true,\n \"tags\": [\n \"app\",\n \"datacenter\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a tag configuration",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name",
"value": "dist.http.endpoint.request"
}
]
},
"description": "Deletes a metric's tag configuration. Can only be used with application\nkeys from users with the `Manage Tags for Metrics` permission."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Search metrics",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/search?q=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"search"
],
"query": [
{
"key": "q",
"value": "sit esse",
"description": "(Required) Query string to search metrics upon. Can optionally be prefixed with `metrics:`."
}
]
},
"description": "Search for metrics from the last 24 hours in Datadog."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/search?q=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"search"
],
"query": [
{
"key": "q",
"value": "sit esse",
"description": "(Required) Query string to search metrics upon. Can optionally be prefixed with `metrics:`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"results\": {\n \"metrics\": [\n \"eu officia ullamco\",\n \"ut qu\"\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/search?q=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"search"
],
"query": [
{
"key": "q",
"value": "sit esse",
"description": "(Required) Query string to search metrics upon. Can optionally be prefixed with `metrics:`."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/search?q=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"search"
],
"query": [
{
"key": "q",
"value": "sit esse",
"description": "(Required) Query string to search metrics upon. Can optionally be prefixed with `metrics:`."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/search?q=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"search"
],
"query": [
{
"key": "q",
"value": "sit esse",
"description": "(Required) Query string to search metrics upon. Can optionally be prefixed with `metrics:`."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a list of metrics",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics?filter[configured]=true&filter[tags_configured]=app&filter[metric_type]=distribution&filter[include_percentiles]=true&filter[queried]=true&filter[tags]=env IN (staging,test) AND service:web&filter[related_assets]=true&window[seconds]=3600&page[size]=10000&page[cursor]=proident amet voluptate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics"
],
"query": [
{
"key": "filter[configured]",
"value": "true",
"description": "Filter custom metrics that have configured tags."
},
{
"key": "filter[tags_configured]",
"value": "app",
"description": "Filter tag configurations by configured tags."
},
{
"key": "filter[metric_type]",
"value": "distribution",
"description": "Filter metrics by metric type."
},
{
"key": "filter[include_percentiles]",
"value": "true",
"description": "Filter distributions with additional percentile\naggregations enabled or disabled."
},
{
"key": "filter[queried]",
"value": "true",
"description": "(Preview) Filter custom metrics that have or have not been queried in the specified window[seconds].\nIf no window is provided or the window is less than 2 hours, a default of 2 hours will be applied."
},
{
"key": "filter[tags]",
"value": "env IN (staging,test) AND service:web",
"description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCan only be combined with the filter[queried] filter."
},
{
"key": "filter[related_assets]",
"value": "true",
"description": "(Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs."
},
{
"key": "window[seconds]",
"value": "3600",
"description": "The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query.\nDefault value is 3600 (1 hour), maximum value is 2,592,000 (30 days)."
},
{
"key": "page[size]",
"value": "10000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "proident amet voluptate",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.pagination.next_cursor`.\nOnce the `meta.pagination.next_cursor` key is null, all pages have been retrieved."
}
]
},
"description": "Returns all metrics that can be configured in the Metrics Summary page or with Metrics without Limits™ (matching additional filters if specified).\nOptionally, paginate by using the `page[cursor]` and/or `page[size]` query parameters.\nTo fetch the first page, pass in a query parameter with either a valid `page[size]` or an empty cursor like `page[cursor]=`. To fetch the next page, pass in the `next_cursor` value from the response as the new `page[cursor]` value.\nOnce the `meta.pagination.next_cursor` value is null, all pages have been retrieved."
},
"response": [
{
"name": "Success",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics?filter[configured]=true&filter[tags_configured]=app&filter[metric_type]=distribution&filter[include_percentiles]=true&filter[queried]=true&filter[tags]=env IN (staging,test) AND service:web&filter[related_assets]=true&window[seconds]=3600&page[size]=10000&page[cursor]=proident amet voluptate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics"
],
"query": [
{
"key": "filter[configured]",
"value": "true",
"description": "Filter custom metrics that have configured tags."
},
{
"key": "filter[tags_configured]",
"value": "app",
"description": "Filter tag configurations by configured tags."
},
{
"key": "filter[metric_type]",
"value": "distribution",
"description": "Filter metrics by metric type."
},
{
"key": "filter[include_percentiles]",
"value": "true",
"description": "Filter distributions with additional percentile\naggregations enabled or disabled."
},
{
"key": "filter[queried]",
"value": "true",
"description": "(Preview) Filter custom metrics that have or have not been queried in the specified window[seconds].\nIf no window is provided or the window is less than 2 hours, a default of 2 hours will be applied."
},
{
"key": "filter[tags]",
"value": "env IN (staging,test) AND service:web",
"description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCan only be combined with the filter[queried] filter."
},
{
"key": "filter[related_assets]",
"value": "true",
"description": "(Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs."
},
{
"key": "window[seconds]",
"value": "3600",
"description": "The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query.\nDefault value is 3600 (1 hour), maximum value is 2,592,000 (30 days)."
},
{
"key": "page[size]",
"value": "10000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "proident amet voluptate",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.pagination.next_cursor`.\nOnce the `meta.pagination.next_cursor` key is null, all pages have been retrieved."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"type\": \"metrics\"\n },\n {\n \"type\": \"metrics\"\n }\n ],\n \"links\": {\n \"first\": \"sint dolore sit\",\n \"last\": \"do commodo Lorem\",\n \"next\": \"commodo non ex\",\n \"prev\": \"irure sint non Ut cupidatat\",\n \"self\": \"mollit Ut pariatu\"\n },\n \"meta\": {\n \"pagination\": {\n \"cursor\": \"dol\",\n \"limit\": 7145,\n \"next_cursor\": \"labore Duis dolore\",\n \"type\": \"cursor_limit\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics?filter[configured]=true&filter[tags_configured]=app&filter[metric_type]=distribution&filter[include_percentiles]=true&filter[queried]=true&filter[tags]=env IN (staging,test) AND service:web&filter[related_assets]=true&window[seconds]=3600&page[size]=10000&page[cursor]=proident amet voluptate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics"
],
"query": [
{
"key": "filter[configured]",
"value": "true",
"description": "Filter custom metrics that have configured tags."
},
{
"key": "filter[tags_configured]",
"value": "app",
"description": "Filter tag configurations by configured tags."
},
{
"key": "filter[metric_type]",
"value": "distribution",
"description": "Filter metrics by metric type."
},
{
"key": "filter[include_percentiles]",
"value": "true",
"description": "Filter distributions with additional percentile\naggregations enabled or disabled."
},
{
"key": "filter[queried]",
"value": "true",
"description": "(Preview) Filter custom metrics that have or have not been queried in the specified window[seconds].\nIf no window is provided or the window is less than 2 hours, a default of 2 hours will be applied."
},
{
"key": "filter[tags]",
"value": "env IN (staging,test) AND service:web",
"description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCan only be combined with the filter[queried] filter."
},
{
"key": "filter[related_assets]",
"value": "true",
"description": "(Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs."
},
{
"key": "window[seconds]",
"value": "3600",
"description": "The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query.\nDefault value is 3600 (1 hour), maximum value is 2,592,000 (30 days)."
},
{
"key": "page[size]",
"value": "10000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "proident amet voluptate",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.pagination.next_cursor`.\nOnce the `meta.pagination.next_cursor` key is null, all pages have been retrieved."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics?filter[configured]=true&filter[tags_configured]=app&filter[metric_type]=distribution&filter[include_percentiles]=true&filter[queried]=true&filter[tags]=env IN (staging,test) AND service:web&filter[related_assets]=true&window[seconds]=3600&page[size]=10000&page[cursor]=proident amet voluptate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics"
],
"query": [
{
"key": "filter[configured]",
"value": "true",
"description": "Filter custom metrics that have configured tags."
},
{
"key": "filter[tags_configured]",
"value": "app",
"description": "Filter tag configurations by configured tags."
},
{
"key": "filter[metric_type]",
"value": "distribution",
"description": "Filter metrics by metric type."
},
{
"key": "filter[include_percentiles]",
"value": "true",
"description": "Filter distributions with additional percentile\naggregations enabled or disabled."
},
{
"key": "filter[queried]",
"value": "true",
"description": "(Preview) Filter custom metrics that have or have not been queried in the specified window[seconds].\nIf no window is provided or the window is less than 2 hours, a default of 2 hours will be applied."
},
{
"key": "filter[tags]",
"value": "env IN (staging,test) AND service:web",
"description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCan only be combined with the filter[queried] filter."
},
{
"key": "filter[related_assets]",
"value": "true",
"description": "(Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs."
},
{
"key": "window[seconds]",
"value": "3600",
"description": "The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query.\nDefault value is 3600 (1 hour), maximum value is 2,592,000 (30 days)."
},
{
"key": "page[size]",
"value": "10000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "proident amet voluptate",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.pagination.next_cursor`.\nOnce the `meta.pagination.next_cursor` key is null, all pages have been retrieved."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics?filter[configured]=true&filter[tags_configured]=app&filter[metric_type]=distribution&filter[include_percentiles]=true&filter[queried]=true&filter[tags]=env IN (staging,test) AND service:web&filter[related_assets]=true&window[seconds]=3600&page[size]=10000&page[cursor]=proident amet voluptate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics"
],
"query": [
{
"key": "filter[configured]",
"value": "true",
"description": "Filter custom metrics that have configured tags."
},
{
"key": "filter[tags_configured]",
"value": "app",
"description": "Filter tag configurations by configured tags."
},
{
"key": "filter[metric_type]",
"value": "distribution",
"description": "Filter metrics by metric type."
},
{
"key": "filter[include_percentiles]",
"value": "true",
"description": "Filter distributions with additional percentile\naggregations enabled or disabled."
},
{
"key": "filter[queried]",
"value": "true",
"description": "(Preview) Filter custom metrics that have or have not been queried in the specified window[seconds].\nIf no window is provided or the window is less than 2 hours, a default of 2 hours will be applied."
},
{
"key": "filter[tags]",
"value": "env IN (staging,test) AND service:web",
"description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCan only be combined with the filter[queried] filter."
},
{
"key": "filter[related_assets]",
"value": "true",
"description": "(Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs."
},
{
"key": "window[seconds]",
"value": "3600",
"description": "The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query.\nDefault value is 3600 (1 hour), maximum value is 2,592,000 (30 days)."
},
{
"key": "page[size]",
"value": "10000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "proident amet voluptate",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.pagination.next_cursor`.\nOnce the `meta.pagination.next_cursor` key is null, all pages have been retrieved."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Query timeseries points",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/query?from=10554192&to=10554192&query=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"query"
],
"query": [
{
"key": "from",
"value": "10554192",
"description": "(Required) Start of the queried time period, seconds since the Unix epoch."
},
{
"key": "to",
"value": "10554192",
"description": "(Required) End of the queried time period, seconds since the Unix epoch."
},
{
"key": "query",
"value": "sit esse",
"description": "(Required) Query string."
}
]
},
"description": "Query timeseries points."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/query?from=10554192&to=10554192&query=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"query"
],
"query": [
{
"key": "from",
"value": "10554192",
"description": "(Required) Start of the queried time period, seconds since the Unix epoch."
},
{
"key": "to",
"value": "10554192",
"description": "(Required) End of the queried time period, seconds since the Unix epoch."
},
{
"key": "query",
"value": "sit esse",
"description": "(Required) Query string."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"ut cupidatat\",\n \"from_date\": -88595494,\n \"group_by\": [\n \"in adipisicing aliqua\",\n \"consequat dolore velit\"\n ],\n \"message\": \"in dolore eu in au\",\n \"query\": \"magna deserunt in\",\n \"res_type\": \"time_series\",\n \"series\": [\n {\n \"aggr\": \"avg\",\n \"display_name\": \"system.cpu.idle\",\n \"end\": 91134058,\n \"expression\": \"system.cpu.idle{host:foo,env:test}\",\n \"interval\": -47777177,\n \"length\": -64829914,\n \"metric\": \"system.cpu.idle\",\n \"pointlist\": [\n [\n 1681683300000,\n 77.62145685254418\n ]\n ],\n \"query_index\": -13865242,\n \"scope\": \"host:foo,env:test\",\n \"start\": 85946010,\n \"tag_set\": [\n \"nostrud culpa\",\n \"consectetur incididunt ipsum eiusmod\"\n ],\n \"unit\": [\n {\n \"family\": \"time\",\n \"name\": \"minute\",\n \"plural\": \"minutes\",\n \"scale_factor\": 60,\n \"short_name\": \"min\"\n },\n {\n \"family\": \"time\",\n \"name\": \"minute\",\n \"plural\": \"minutes\",\n \"scale_factor\": 60,\n \"short_name\": \"min\"\n }\n ]\n },\n {\n \"aggr\": \"avg\",\n \"display_name\": \"system.cpu.idle\",\n \"end\": 82646381,\n \"expression\": \"system.cpu.idle{host:foo,env:test}\",\n \"interval\": -99549164,\n \"length\": 71020144,\n \"metric\": \"system.cpu.idle\",\n \"pointlist\": [\n [\n 1681683300000,\n 77.62145685254418\n ]\n ],\n \"query_index\": 66948433,\n \"scope\": \"host:foo,env:test\",\n \"start\": 12015177,\n \"tag_set\": [\n \"dolor eu esse nostrud\",\n \"velit consectetur\"\n ],\n \"unit\": [\n {\n \"family\": \"time\",\n \"name\": \"minute\",\n \"plural\": \"minutes\",\n \"scale_factor\": 60,\n \"short_name\": \"min\"\n },\n {\n \"family\": \"time\",\n \"name\": \"minute\",\n \"plural\": \"minutes\",\n \"scale_factor\": 60,\n \"short_name\": \"min\"\n }\n ]\n }\n ],\n \"status\": \"ok\",\n \"to_date\": -83014360\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/query?from=10554192&to=10554192&query=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"query"
],
"query": [
{
"key": "from",
"value": "10554192",
"description": "(Required) Start of the queried time period, seconds since the Unix epoch."
},
{
"key": "to",
"value": "10554192",
"description": "(Required) End of the queried time period, seconds since the Unix epoch."
},
{
"key": "query",
"value": "sit esse",
"description": "(Required) Query string."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/query?from=10554192&to=10554192&query=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"query"
],
"query": [
{
"key": "from",
"value": "10554192",
"description": "(Required) Start of the queried time period, seconds since the Unix epoch."
},
{
"key": "to",
"value": "10554192",
"description": "(Required) End of the queried time period, seconds since the Unix epoch."
},
{
"key": "query",
"value": "sit esse",
"description": "(Required) Query string."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/query?from=10554192&to=10554192&query=sit esse",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"query"
],
"query": [
{
"key": "from",
"value": "10554192",
"description": "(Required) Start of the queried time period, seconds since the Unix epoch."
},
{
"key": "to",
"value": "10554192",
"description": "(Required) End of the queried time period, seconds since the Unix epoch."
},
{
"key": "query",
"value": "sit esse",
"description": "(Required) Query string."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List tags by metric name",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/all-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"all-tags"
],
"variable": [
{
"key": "metric_name",
"value": "dist.http.endpoint.request"
}
]
},
"description": "View indexed tag key-value pairs for a given metric name over the previous hour."
},
"response": [
{
"name": "Success",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/all-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"all-tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"tags\": [\n \"sport:golf\",\n \"sport:football\",\n \"animal:dog\"\n ]\n },\n \"id\": \"test.metric.latency\",\n \"type\": \"metrics\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/all-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"all-tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/all-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"all-tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/all-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"all-tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/all-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"all-tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List active tags and aggregations",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/active-configurations?window[seconds]=7200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"active-configurations"
],
"query": [
{
"key": "window[seconds]",
"value": "7200",
"description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
}
],
"variable": [
{
"key": "metric_name",
"value": "dist.http.endpoint.request"
}
]
},
"description": "List tags and aggregations that are actively queried on dashboards, notebooks, monitors, the Metrics Explorer, and using the API for a given metric name."
},
"response": [
{
"name": "Success",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/active-configurations?window[seconds]=7200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"active-configurations"
],
"query": [
{
"key": "window[seconds]",
"value": "7200",
"description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"active_aggregations\": [\n {\n \"space\": \"sum\",\n \"time\": \"sum\"\n },\n {\n \"space\": \"sum\",\n \"time\": \"count\"\n }\n ],\n \"active_tags\": [\n \"app\",\n \"datacenter\"\n ]\n },\n \"id\": \"test.metric.latency\",\n \"type\": \"actively_queried_configurations\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/active-configurations?window[seconds]=7200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"active-configurations"
],
"query": [
{
"key": "window[seconds]",
"value": "7200",
"description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/active-configurations?window[seconds]=7200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"active-configurations"
],
"query": [
{
"key": "window[seconds]",
"value": "7200",
"description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/active-configurations?window[seconds]=7200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"active-configurations"
],
"query": [
{
"key": "window[seconds]",
"value": "7200",
"description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/active-configurations?window[seconds]=7200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"active-configurations"
],
"query": [
{
"key": "window[seconds]",
"value": "7200",
"description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List distinct metric volumes by metric name",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/volumes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"volumes"
],
"variable": [
{
"key": "metric_name",
"value": "dist.http.endpoint.request"
}
]
},
"description": "View distinct metrics volumes for the given metric name.\n\nCustom metrics generated in-app from other products will return `null` for ingested volumes."
},
"response": [
{
"name": "Success",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/volumes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"volumes"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"distinct_volume\": 10\n },\n \"id\": \"test.metric.latency\",\n \"type\": \"distinct_metric_volumes\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/volumes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"volumes"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/volumes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"volumes"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/volumes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"volumes"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/volumes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"volumes"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Configure tags for multiple metrics",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"kafka.lag\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"sue@example.com\",\n \"bob@example.com\"\n ],\n \"exclude_tags_mode\": true,\n \"include_actively_queried_tags_window\": 4170237.1190554067,\n \"override_existing_configurations\": true,\n \"tags\": [\n \"host\",\n \"pod_name\",\n \"is_shadow\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
},
"description": "Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.\nMetrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations.\nResults can be sent to a set of account email addresses, just like the same operation in the Datadog web app.\nIf multiple calls include the same metric, the last configuration applied (not by submit order) is used, do not\nexpect deterministic ordering of concurrent calls. The `exclude_tags_mode` value will set all metrics that match the prefix to\nthe same exclusion state, metric tag configurations do not support mixed inclusion and exclusion for tags on the same metric.\nCan only be used with application keys of users with the `Manage Tags for Metrics` permission."
},
"response": [
{
"name": "Accepted",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"kafka.lag\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"sue@example.com\",\n \"bob@example.com\"\n ],\n \"exclude_tags_mode\": true,\n \"include_actively_queried_tags_window\": 4170237.1190554067,\n \"override_existing_configurations\": true,\n \"tags\": [\n \"host\",\n \"pod_name\",\n \"is_shadow\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"kafka.lag\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"sue@example.com\",\n \"bob@example.com\"\n ],\n \"exclude_tags_mode\": true,\n \"status\": \"Accepted\",\n \"tags\": [\n \"host\",\n \"pod_name\",\n \"is_shadow\"\n ]\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"kafka.lag\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"sue@example.com\",\n \"bob@example.com\"\n ],\n \"exclude_tags_mode\": true,\n \"include_actively_queried_tags_window\": 4170237.1190554067,\n \"override_existing_configurations\": true,\n \"tags\": [\n \"host\",\n \"pod_name\",\n \"is_shadow\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"kafka.lag\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"sue@example.com\",\n \"bob@example.com\"\n ],\n \"exclude_tags_mode\": true,\n \"include_actively_queried_tags_window\": 4170237.1190554067,\n \"override_existing_configurations\": true,\n \"tags\": [\n \"host\",\n \"pod_name\",\n \"is_shadow\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"kafka.lag\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"sue@example.com\",\n \"bob@example.com\"\n ],\n \"exclude_tags_mode\": true,\n \"include_actively_queried_tags_window\": 4170237.1190554067,\n \"override_existing_configurations\": true,\n \"tags\": [\n \"host\",\n \"pod_name\",\n \"is_shadow\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"kafka.lag\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"sue@example.com\",\n \"bob@example.com\"\n ],\n \"exclude_tags_mode\": true,\n \"include_actively_queried_tags_window\": 4170237.1190554067,\n \"override_existing_configurations\": true,\n \"tags\": [\n \"host\",\n \"pod_name\",\n \"is_shadow\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete tags for multiple metrics",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"kafka.lag\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"sue@example.com\",\n \"bob@example.com\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
},
"description": "Delete all custom lists of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.\nMetrics are selected by passing a metric name prefix.\nResults can be sent to a set of account email addresses, just like the same operation in the Datadog web app.\nCan only be used with application keys of users with the `Manage Tags for Metrics` permission."
},
"response": [
{
"name": "Accepted",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"kafka.lag\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"sue@example.com\",\n \"bob@example.com\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"kafka.lag\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"sue@example.com\",\n \"bob@example.com\"\n ],\n \"exclude_tags_mode\": true,\n \"status\": \"Accepted\",\n \"tags\": [\n \"host\",\n \"pod_name\",\n \"is_shadow\"\n ]\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"kafka.lag\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"sue@example.com\",\n \"bob@example.com\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"kafka.lag\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"sue@example.com\",\n \"bob@example.com\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"kafka.lag\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"sue@example.com\",\n \"bob@example.com\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"kafka.lag\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"sue@example.com\",\n \"bob@example.com\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Tag Configuration Cardinality Estimator",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/estimate?filter[groups]=app,host&filter[hours_ago]=49&filter[num_aggregations]=1&filter[pct]=true&filter[timespan_h]=6",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"estimate"
],
"query": [
{
"key": "filter[groups]",
"value": "app,host",
"description": "Filtered tag keys that the metric is configured to query with."
},
{
"key": "filter[hours_ago]",
"value": "49",
"description": "The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours."
},
{
"key": "filter[num_aggregations]",
"value": "1",
"description": "Deprecated. Number of aggregations has no impact on volume."
},
{
"key": "filter[pct]",
"value": "true",
"description": "A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators."
},
{
"key": "filter[timespan_h]",
"value": "6",
"description": "A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour."
}
],
"variable": [
{
"key": "metric_name",
"value": "dist.http.endpoint.request"
}
]
},
"description": "Returns the estimated cardinality for a metric with a given tag, percentile and number of aggregations configuration using Metrics without Limits™."
},
"response": [
{
"name": "Success",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/estimate?filter[groups]=app,host&filter[hours_ago]=49&filter[num_aggregations]=1&filter[pct]=true&filter[timespan_h]=6",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"estimate"
],
"query": [
{
"key": "filter[groups]",
"value": "app,host",
"description": "Filtered tag keys that the metric is configured to query with."
},
{
"key": "filter[hours_ago]",
"value": "49",
"description": "The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours."
},
{
"key": "filter[num_aggregations]",
"value": "1",
"description": "Deprecated. Number of aggregations has no impact on volume."
},
{
"key": "filter[pct]",
"value": "true",
"description": "A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators."
},
{
"key": "filter[timespan_h]",
"value": "6",
"description": "A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"estimate_type\": \"distribution\",\n \"estimated_at\": \"2022-04-27T09:48:37.463835Z\",\n \"estimated_output_series\": 50\n },\n \"id\": \"test.metric.latency\",\n \"type\": \"metric_cardinality_estimate\"\n }\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/estimate?filter[groups]=app,host&filter[hours_ago]=49&filter[num_aggregations]=1&filter[pct]=true&filter[timespan_h]=6",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"estimate"
],
"query": [
{
"key": "filter[groups]",
"value": "app,host",
"description": "Filtered tag keys that the metric is configured to query with."
},
{
"key": "filter[hours_ago]",
"value": "49",
"description": "The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours."
},
{
"key": "filter[num_aggregations]",
"value": "1",
"description": "Deprecated. Number of aggregations has no impact on volume."
},
{
"key": "filter[pct]",
"value": "true",
"description": "A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators."
},
{
"key": "filter[timespan_h]",
"value": "6",
"description": "A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/estimate?filter[groups]=app,host&filter[hours_ago]=49&filter[num_aggregations]=1&filter[pct]=true&filter[timespan_h]=6",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"estimate"
],
"query": [
{
"key": "filter[groups]",
"value": "app,host",
"description": "Filtered tag keys that the metric is configured to query with."
},
{
"key": "filter[hours_ago]",
"value": "49",
"description": "The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours."
},
{
"key": "filter[num_aggregations]",
"value": "1",
"description": "Deprecated. Number of aggregations has no impact on volume."
},
{
"key": "filter[pct]",
"value": "true",
"description": "A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators."
},
{
"key": "filter[timespan_h]",
"value": "6",
"description": "A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/estimate?filter[groups]=app,host&filter[hours_ago]=49&filter[num_aggregations]=1&filter[pct]=true&filter[timespan_h]=6",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"estimate"
],
"query": [
{
"key": "filter[groups]",
"value": "app,host",
"description": "Filtered tag keys that the metric is configured to query with."
},
{
"key": "filter[hours_ago]",
"value": "49",
"description": "The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours."
},
{
"key": "filter[num_aggregations]",
"value": "1",
"description": "Deprecated. Number of aggregations has no impact on volume."
},
{
"key": "filter[pct]",
"value": "true",
"description": "A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators."
},
{
"key": "filter[timespan_h]",
"value": "6",
"description": "A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/estimate?filter[groups]=app,host&filter[hours_ago]=49&filter[num_aggregations]=1&filter[pct]=true&filter[timespan_h]=6",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"estimate"
],
"query": [
{
"key": "filter[groups]",
"value": "app,host",
"description": "Filtered tag keys that the metric is configured to query with."
},
{
"key": "filter[hours_ago]",
"value": "49",
"description": "The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours."
},
{
"key": "filter[num_aggregations]",
"value": "1",
"description": "Deprecated. Number of aggregations has no impact on volume."
},
{
"key": "filter[pct]",
"value": "true",
"description": "A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators."
},
{
"key": "filter[timespan_h]",
"value": "6",
"description": "A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Related Assets to a Metric",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/assets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"assets"
],
"variable": [
{
"key": "metric_name",
"value": "dist.http.endpoint.request"
}
]
},
"description": "Returns dashboards, monitors, notebooks, and SLOs that a metric is stored in, if any. Updated every 24 hours."
},
"response": [
{
"name": "Success",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/assets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"assets"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"test.metric.latency\",\n \"type\": \"metrics\",\n \"relationships\": {\n \"dashboards\": {\n \"data\": [\n {\n \"id\": \"xxx-yyy-zzz\",\n \"type\": \"dashboards\"\n },\n {\n \"id\": \"xxx-yyy-zzz\",\n \"type\": \"dashboards\"\n }\n ]\n },\n \"monitors\": {\n \"data\": [\n {\n \"id\": \"1775073\",\n \"type\": \"monitors\"\n },\n {\n \"id\": \"1775073\",\n \"type\": \"monitors\"\n }\n ]\n },\n \"notebooks\": {\n \"data\": [\n {\n \"id\": \"12345\",\n \"type\": \"notebooks\"\n },\n {\n \"id\": \"12345\",\n \"type\": \"notebooks\"\n }\n ]\n },\n \"slos\": {\n \"data\": [\n {\n \"id\": \"9ffef113b389520db54391d67d652dfb\",\n \"type\": \"slos\"\n },\n {\n \"id\": \"9ffef113b389520db54391d67d652dfb\",\n \"type\": \"slos\"\n }\n ]\n }\n }\n },\n \"included\": [\n {\n \"id\": \"xxx-yyy-zzz\",\n \"type\": \"dashboards\",\n \"attributes\": {\n \"popularity\": 4.357018747192733,\n \"tags\": [\n \"env\",\n \"service\",\n \"host\",\n \"datacenter\"\n ],\n \"title\": \"qui ut culpa dolor consequa\",\n \"url\": \"sed do consequat sunt\"\n }\n },\n {\n \"id\": \"xxx-yyy-zzz\",\n \"type\": \"dashboards\",\n \"attributes\": {\n \"popularity\": 1.7902440316355572,\n \"tags\": [\n \"env\",\n \"service\",\n \"host\",\n \"datacenter\"\n ],\n \"title\": \"minim dolore\",\n \"url\": \"enim ad\"\n }\n }\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/assets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"assets"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/assets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"assets"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/assets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"assets"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/assets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"assets"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get tag key cardinality details",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tag-cardinalities",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tag-cardinalities"
],
"variable": [
{
"key": "metric_name",
"value": "dist.http.endpoint.request"
}
]
},
"description": "Returns the cardinality details of tags for a specific metric."
},
"response": [
{
"name": "Success",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tag-cardinalities",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tag-cardinalities"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"cardinality_delta\": 25\n },\n \"type\": \"tag_cardinality\"\n },\n {\n \"attributes\": {\n \"cardinality_delta\": 25\n },\n \"type\": \"tag_cardinality\"\n }\n ],\n \"meta\": {\n \"metric_name\": \"commodo ex\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tag-cardinalities",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tag-cardinalities"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tag-cardinalities",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tag-cardinalities"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tag-cardinalities",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tag-cardinalities"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tag-cardinalities",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tag-cardinalities"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "The metrics endpoint allows you to:\n\n- Post metrics data so it can be graphed on Datadog’s dashboards\n- Query metrics from any time period (timeseries and scalar)\n- Modify tag configurations for metrics\n- View tags and volumes for metrics\n\n**Note**: A graph can only contain a set number of points\nand as the timeframe over which a metric is viewed increases,\naggregation between points occurs to stay below that set number.\n\nThe Post, Patch, and Delete `manage_tags` API methods can only be performed by\na user who has the `Manage Tags for Metrics` permission.\n\nSee the [Metrics page](https://docs.datadoghq.com/metrics/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Microsoft Teams Integration",
"item": [
{
"name": "Create tenant-based handle",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"channel_id\": \"fake-channel-id\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles"
]
},
"description": "Create a tenant-based handle in the Datadog Microsoft Teams integration."
},
"response": [
{
"name": "CREATED",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"channel_id\": \"fake-channel-id\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"channel_id\": \"fake-channel-id\",\n \"name\": \"fake-handle-name\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n },\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"tenant-based-handle\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"channel_id\": \"fake-channel-id\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"channel_id\": \"fake-channel-id\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"channel_id\": \"fake-channel-id\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"channel_id\": \"fake-channel-id\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Failed Precondition",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"channel_id\": \"fake-channel-id\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles"
]
}
},
"status": "Precondition Failed",
"code": 412,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"channel_id\": \"fake-channel-id\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create Workflows webhook handle",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles"
]
},
"description": "Create a Workflows webhook handle in the Datadog Microsoft Teams integration."
},
"response": [
{
"name": "CREATED",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"fake-handle-name\"\n },\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"workflows-webhook-handle\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Failed Precondition",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles"
]
}
},
"status": "Precondition Failed",
"code": 412,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete tenant-based handle",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id",
"value": "aliquip laborum ex velit"
}
]
},
"description": "Delete a tenant-based handle from the Datadog Microsoft Teams integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Failed Precondition",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Precondition Failed",
"code": 412,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete Workflows webhook handle",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id",
"value": "aliquip laborum ex velit"
}
]
},
"description": "Delete a Workflows webhook handle from the Datadog Microsoft Teams integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Failed Precondition",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Precondition Failed",
"code": 412,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all tenant-based handles",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles?tenant_id=aliquip laborum ex velit&name=aliquip laborum ex velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles"
],
"query": [
{
"key": "tenant_id",
"value": "aliquip laborum ex velit",
"description": "Your tenant id."
},
{
"key": "name",
"value": "aliquip laborum ex velit",
"description": "Your tenant-based handle name."
}
]
},
"description": "Get a list of all tenant-based handles from the Datadog Microsoft Teams integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles?tenant_id=aliquip laborum ex velit&name=aliquip laborum ex velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles"
],
"query": [
{
"key": "tenant_id",
"value": "aliquip laborum ex velit",
"description": "Your tenant id."
},
{
"key": "name",
"value": "aliquip laborum ex velit",
"description": "Your tenant-based handle name."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"channelId\": \"19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2\",\n \"channelName\": \"General\",\n \"name\": \"general-handle\",\n \"teamId\": \"00000000-0000-0000-0000-000000000000\",\n \"teamName\": \"Example Team\",\n \"tenantId\": \"00000000-0000-0000-0000-000000000001\",\n \"tenantName\": \"Company, Inc.\"\n },\n \"type\": \"ms-teams-tenant-based-handle-info\"\n },\n {\n \"attributes\": {\n \"channelId\": \"19:b41k24b14bn1nwffkernfkwrnfneubgk1@thread.tacv2\",\n \"channelName\": \"General2\",\n \"name\": \"general-handle-2\",\n \"teamId\": \"00000000-0000-0000-0000-000000000002\",\n \"teamName\": \"Example Team 2\",\n \"tenantId\": \"00000000-0000-0000-0000-000000000003\",\n \"tenantName\": \"Company, Inc.\"\n },\n \"type\": \"ms-teams-tenant-based-handle-info\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles?tenant_id=aliquip laborum ex velit&name=aliquip laborum ex velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles"
],
"query": [
{
"key": "tenant_id",
"value": "aliquip laborum ex velit",
"description": "Your tenant id."
},
{
"key": "name",
"value": "aliquip laborum ex velit",
"description": "Your tenant-based handle name."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles?tenant_id=aliquip laborum ex velit&name=aliquip laborum ex velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles"
],
"query": [
{
"key": "tenant_id",
"value": "aliquip laborum ex velit",
"description": "Your tenant id."
},
{
"key": "name",
"value": "aliquip laborum ex velit",
"description": "Your tenant-based handle name."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles?tenant_id=aliquip laborum ex velit&name=aliquip laborum ex velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles"
],
"query": [
{
"key": "tenant_id",
"value": "aliquip laborum ex velit",
"description": "Your tenant id."
},
{
"key": "name",
"value": "aliquip laborum ex velit",
"description": "Your tenant-based handle name."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Failed Precondition",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles?tenant_id=aliquip laborum ex velit&name=aliquip laborum ex velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles"
],
"query": [
{
"key": "tenant_id",
"value": "aliquip laborum ex velit",
"description": "Your tenant id."
},
{
"key": "name",
"value": "aliquip laborum ex velit",
"description": "Your tenant-based handle name."
}
]
}
},
"status": "Precondition Failed",
"code": 412,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles?tenant_id=aliquip laborum ex velit&name=aliquip laborum ex velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles"
],
"query": [
{
"key": "tenant_id",
"value": "aliquip laborum ex velit",
"description": "Your tenant id."
},
{
"key": "name",
"value": "aliquip laborum ex velit",
"description": "Your tenant-based handle name."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all Workflows webhook handles",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles?name=aliquip laborum ex velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles"
],
"query": [
{
"key": "name",
"value": "aliquip laborum ex velit",
"description": "Your Workflows webhook handle name."
}
]
},
"description": "Get a list of all Workflows webhook handles from the Datadog Microsoft Teams integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles?name=aliquip laborum ex velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles"
],
"query": [
{
"key": "name",
"value": "aliquip laborum ex velit",
"description": "Your Workflows webhook handle name."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"name\": \"general-handle\"\n },\n \"type\": \"workflows-webhook-handle\"\n },\n {\n \"attributes\": {\n \"name\": \"general-handle-2\"\n },\n \"type\": \"workflows-webhook-handle\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles?name=aliquip laborum ex velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles"
],
"query": [
{
"key": "name",
"value": "aliquip laborum ex velit",
"description": "Your Workflows webhook handle name."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles?name=aliquip laborum ex velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles"
],
"query": [
{
"key": "name",
"value": "aliquip laborum ex velit",
"description": "Your Workflows webhook handle name."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles?name=aliquip laborum ex velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles"
],
"query": [
{
"key": "name",
"value": "aliquip laborum ex velit",
"description": "Your Workflows webhook handle name."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Failed Precondition",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles?name=aliquip laborum ex velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles"
],
"query": [
{
"key": "name",
"value": "aliquip laborum ex velit",
"description": "Your Workflows webhook handle name."
}
]
}
},
"status": "Precondition Failed",
"code": 412,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles?name=aliquip laborum ex velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles"
],
"query": [
{
"key": "name",
"value": "aliquip laborum ex velit",
"description": "Your Workflows webhook handle name."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get channel information by name",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/channel/:tenant_name/:team_name/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"channel",
":tenant_name",
":team_name",
":channel_name"
],
"variable": [
{
"key": "tenant_name",
"value": "aliquip laborum ex velit"
},
{
"key": "team_name",
"value": "aliquip laborum ex velit"
},
{
"key": "channel_name",
"value": "aliquip laborum ex velit"
}
]
},
"description": "Get the tenant, team, and channel ID of a channel in the Datadog Microsoft Teams integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/channel/:tenant_name/:team_name/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"channel",
":tenant_name",
":team_name",
":channel_name"
],
"variable": [
{
"key": "tenant_name"
},
{
"key": "team_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"is_primary\": true,\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n },\n \"id\": \"19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2\",\n \"type\": \"ms-teams-channel-info\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/channel/:tenant_name/:team_name/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"channel",
":tenant_name",
":team_name",
":channel_name"
],
"variable": [
{
"key": "tenant_name"
},
{
"key": "team_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/channel/:tenant_name/:team_name/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"channel",
":tenant_name",
":team_name",
":channel_name"
],
"variable": [
{
"key": "tenant_name"
},
{
"key": "team_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/channel/:tenant_name/:team_name/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"channel",
":tenant_name",
":team_name",
":channel_name"
],
"variable": [
{
"key": "tenant_name"
},
{
"key": "team_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/channel/:tenant_name/:team_name/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"channel",
":tenant_name",
":team_name",
":channel_name"
],
"variable": [
{
"key": "tenant_name"
},
{
"key": "team_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get tenant-based handle information",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id",
"value": "aliquip laborum ex velit"
}
]
},
"description": "Get the tenant, team, and channel information of a tenant-based handle from the Datadog Microsoft Teams integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"channel_id\": \"fake-channel-id\",\n \"name\": \"fake-handle-name\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n },\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"tenant-based-handle\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Failed Precondition",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Precondition Failed",
"code": 412,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get Workflows webhook handle information",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id",
"value": "aliquip laborum ex velit"
}
]
},
"description": "Get the name of a Workflows webhook handle from the Datadog Microsoft Teams integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"fake-handle-name\"\n },\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"workflows-webhook-handle\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Failed Precondition",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Precondition Failed",
"code": 412,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update tenant-based handle",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"channel_id\": \"fake-channel-id\",\n \"name\": \"fake-handle-name\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id",
"value": "aliquip laborum ex velit"
}
]
},
"description": "Update a tenant-based handle from the Datadog Microsoft Teams integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"channel_id\": \"fake-channel-id\",\n \"name\": \"fake-handle-name\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"channel_id\": \"fake-channel-id\",\n \"name\": \"fake-handle-name\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n },\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"tenant-based-handle\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"channel_id\": \"fake-channel-id\",\n \"name\": \"fake-handle-name\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"channel_id\": \"fake-channel-id\",\n \"name\": \"fake-handle-name\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"channel_id\": \"fake-channel-id\",\n \"name\": \"fake-handle-name\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"channel_id\": \"fake-channel-id\",\n \"name\": \"fake-handle-name\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Failed Precondition",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"channel_id\": \"fake-channel-id\",\n \"name\": \"fake-handle-name\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Precondition Failed",
"code": 412,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"tenant-based-handle\",\n \"attributes\": {\n \"channel_id\": \"fake-channel-id\",\n \"name\": \"fake-handle-name\",\n \"team_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id\": \"00000000-0000-0000-0000-000000000001\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"tenant-based-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update Workflows webhook handle",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id",
"value": "aliquip laborum ex velit"
}
]
},
"description": "Update a Workflows webhook handle from the Datadog Microsoft Teams integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"fake-handle-name\"\n },\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"workflows-webhook-handle\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Failed Precondition",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Precondition Failed",
"code": 412,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"workflows-webhook-handle\",\n \"attributes\": {\n \"name\": \"fake-handle-name\",\n \"url\": \"https://fake.url.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"ms-teams",
"configuration",
"workflows-webhook-handles",
":handle_id"
],
"variable": [
{
"key": "handle_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Configure your [Datadog Microsoft Teams integration](https://docs.datadoghq.com/integrations/microsoft_teams/)\ndirectly through the Datadog API. Note: These endpoints do not support legacy connector handles.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Monitors",
"item": [
{
"name": "Create a monitor",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"message\": \"You may need to add web hosts if this is consistently high.\",\n \"name\": \"Bytes received on host0\",\n \"options\": {\n \"no_data_timeframe\": 20,\n \"notify_no_data\": true\n },\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"tags\": [\n \"app:webserver\",\n \"frontend\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
]
},
"description": "Create a monitor using the specified options.\n\n#### Monitor Types\n\nThe type of monitor chosen from:\n\n- anomaly: `query alert`\n- APM: `query alert` or `trace-analytics alert`\n- composite: `composite`\n- custom: `service check`\n- forecast: `query alert`\n- host: `service check`\n- integration: `query alert` or `service check`\n- live process: `process alert`\n- logs: `log alert`\n- metric: `query alert`\n- network: `service check`\n- outlier: `query alert`\n- process: `service check`\n- rum: `rum alert`\n- SLO: `slo alert`\n- watchdog: `event-v2 alert`\n- event-v2: `event-v2 alert`\n- audit: `audit alert`\n- error-tracking: `error-tracking alert`\n- database-monitoring: `database-monitoring alert`\n- network-performance: `network-performance alert`\n- cloud cost: `cost alert`\n\n**Notes**:\n- Synthetic monitors are created through the Synthetics API. See the [Synthetics API](https://docs.datadoghq.com/api/latest/synthetics/) documentation for more information.\n- Log monitors require an unscoped App Key.\n\n#### Query Types\n\n##### Metric Alert Query\n\nExample: `time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #`\n\n- `time_aggr`: avg, sum, max, min, change, or pct_change\n- `time_window`: `last_#m` (with `#` between 1 and 10080 depending on the monitor type) or `last_#h`(with `#` between 1 and 168 depending on the monitor type) or `last_1d`, or `last_1w`\n- `space_aggr`: avg, sum, min, or max\n- `tags`: one or more tags (comma-separated), or *\n- `key`: a 'key' in key:value tag syntax; defines a separate alert for each tag in the group (multi-alert)\n- `operator`: <, <=, >, >=, ==, or !=\n- `#`: an integer or decimal number used to set the threshold\n\nIf you are using the `_change_` or `_pct_change_` time aggregator, instead use `change_aggr(time_aggr(time_window),\ntimeshift):space_aggr:metric{tags} [by {key}] operator #` with:\n\n- `change_aggr` change, pct_change\n- `time_aggr` avg, sum, max, min [Learn more](https://docs.datadoghq.com/monitors/create/types/#define-the-conditions)\n- `time_window` last\\_#m (between 1 and 2880 depending on the monitor type), last\\_#h (between 1 and 48 depending on the monitor type), or last_#d (1 or 2)\n- `timeshift` #m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_ago\n\nUse this to create an outlier monitor using the following query:\n`avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0`\n\n##### Service Check Query\n\nExample: `\"check\".over(tags).last(count).by(group).count_by_status()`\n\n- `check` name of the check, for example `datadog.agent.up`\n- `tags` one or more quoted tags (comma-separated), or \"*\". for example: `.over(\"env:prod\", \"role:db\")`; `over` cannot be blank.\n- `count` must be at greater than or equal to your max threshold (defined in the `options`). It is limited to 100.\nFor example, if you've specified to notify on 1 critical, 3 ok, and 2 warn statuses, `count` should be at least 3.\n- `group` must be specified for check monitors. Per-check grouping is already explicitly known for some service checks.\nFor example, Postgres integration monitors are tagged by `db`, `host`, and `port`, and Network monitors by `host`, `instance`, and `url`. See [Service Checks](https://docs.datadoghq.com/api/latest/service-checks/) documentation for more information.\n\n##### Event Alert Query\n\n**Note:** The Event Alert Query has been replaced by the Event V2 Alert Query. For more information, see the [Event Migration guide](https://docs.datadoghq.com/service_management/events/guides/migrating_to_new_events_features/).\n\n##### Event V2 Alert Query\n\nExample: `events(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`.\n- `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n##### Process Alert Query\n\nExample: `processes(search).over(tags).rollup('count').last(timeframe) operator #`\n\n- `search` free text search string for querying processes.\nMatching processes match results on the [Live Processes](https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows) page.\n- `tags` one or more tags (comma-separated)\n- `timeframe` the timeframe to roll up the counts. Examples: 10m, 4h. Supported timeframes: s, m, h and d\n- `operator` <, <=, >, >=, ==, or !=\n- `#` an integer or decimal number used to set the threshold\n\n##### Logs Alert Query\n\nExample: `logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `index_name` For multi-index organizations, the log index in which the request is performed.\n- `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`.\n- `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n##### Composite Query\n\nExample: `12345 && 67890`, where `12345` and `67890` are the IDs of non-composite monitors\n\n* `name` [*required*, *default* = **dynamic, based on query**]: The name of the alert.\n* `message` [*required*, *default* = **dynamic, based on query**]: A message to include with notifications for this monitor.\nEmail notifications can be sent to specific users by using the same '@username' notation as events.\n* `tags` [*optional*, *default* = **empty list**]: A list of tags to associate with your monitor.\nWhen getting all monitor details via the API, use the `monitor_tags` argument to filter results by these tags.\nIt is only available via the API and isn't visible or editable in the Datadog UI.\n\n##### SLO Alert Query\n\nExample: `error_budget(\"slo_id\").over(\"time_window\") operator #`\n\n- `slo_id`: The alphanumeric SLO ID of the SLO you are configuring the alert for.\n- `time_window`: The time window of the SLO target you wish to alert on. Valid options: `7d`, `30d`, `90d`.\n- `operator`: `>=` or `>`\n\n##### Audit Alert Query\n\nExample: `audits(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`.\n- `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n##### CI Pipelines Alert Query\n\nExample: `ci-pipelines(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.\n- `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n##### CI Tests Alert Query\n\nExample: `ci-tests(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.\n- `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n##### Error Tracking Alert Query\n\n\"New issue\" example: `error-tracking(query).source(issue_source).new().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #`\n\"High impact issue\" example: `error-tracking(query).source(issue_source).impact().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `issue_source` The issue source - supports `all`, `browser`, `mobile` and `backend` and defaults to `all` if omitted.\n- `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality` and defaults to `count` if omitted.\n- `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.\n- `group by` Comma-separated list of attributes to group by - should contain at least `issue.id`.\n- `time_window` #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n**Database Monitoring Alert Query**\n\nExample: `database-monitoring(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.\n- `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n**Network Performance Alert Query**\n\nExample: `network-performance(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.\n- `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n**Cost Alert Query**\n\nExample: `formula(query).timeframe_type(time_window).function(parameter) operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- `timeframe_type` The timeframe type to evaluate the cost\n - for `forecast` supports `current`\n - for `change`, `anomaly`, `threshold` supports `last`\n- `time_window` - supports daily roll-up e.g. `7d`\n- `function` - [optional, defaults to `threshold` monitor if omitted] supports `change`, `anomaly`, `forecast`\n- `parameter` Specify the parameter of the type\n - for `change`:\n - supports `relative`, `absolute`\n - [optional] supports `#`, where `#` is an integer or decimal number used to set the threshold\n - for `anomaly`:\n - supports `direction=both`, `direction=above`, `direction=below`\n - [optional] supports `threshold=#`, where `#` is an integer or decimal number used to set the threshold\n- `operator`\n - for `threshold` supports `<`, `<=`, `>`, `>=`, `==`, or `!=`\n - for `change` supports `>`, `<`\n - for `anomaly` supports `>=`\n - for `forecast` supports `>`\n- `#` an integer or decimal number used to set the threshold."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"message\": \"You may need to add web hosts if this is consistently high.\",\n \"name\": \"Bytes received on host0\",\n \"options\": {\n \"no_data_timeframe\": 20,\n \"notify_no_data\": true\n },\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"tags\": [\n \"app:webserver\",\n \"frontend\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2014-02-16T14:08:29.440Z\",\n \"creator\": {\n \"email\": \"sunt exercitation voluptate\",\n \"handle\": \"ma\",\n \"name\": \"esse reprehenderit\"\n },\n \"deleted\": \"1987-05-02T07:30:02.904Z\",\n \"draft_status\": \"published\",\n \"id\": 95649884,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"et qui Excepteur\",\n \"modified\": \"1948-03-12T17:49:01.503Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"fugiat ut commodo laborum\",\n \"evaluation_delay\": -40880516,\n \"group_retention_duration\": \"dolore mollit est\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 32618451,\n \"no_data_timeframe\": -85911134,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"minim\",\n \"sit Lorem\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -29024969,\n \"renotify_statuses\": [\n \"warn\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in non si\",\n \"trigger_window\": \"ea a\"\n },\n \"thresholds\": {\n \"critical\": 34990346.50507483,\n \"critical_recovery\": -79917454.46738935,\n \"ok\": 63763340.79153466,\n \"unknown\": -53094457.55030664,\n \"warning\": -13474871.34216705,\n \"warning_recovery\": -37101064.62721461\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"et consectetur sed cillum ex\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliqua Lorem\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliquip ullamco laboris\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor adipisicing cupidatat irure\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 387761,\n \"restricted_roles\": [\n \"sint ut eu\",\n \"nisi\"\n ],\n \"state\": {\n \"groups\": {\n \"deseruntf65\": {\n \"last_nodata_ts\": 17897411,\n \"last_notified_ts\": -71309019,\n \"last_resolved_ts\": -16413311,\n \"last_triggered_ts\": 88296706,\n \"name\": \"eu aliq\",\n \"status\": \"Skipped\"\n }\n }\n },\n \"tags\": [\n \"dolore enim cillum\",\n \"laborum do\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"message\": \"You may need to add web hosts if this is consistently high.\",\n \"name\": \"Bytes received on host0\",\n \"options\": {\n \"no_data_timeframe\": 20,\n \"notify_no_data\": true\n },\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"tags\": [\n \"app:webserver\",\n \"frontend\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"message\": \"You may need to add web hosts if this is consistently high.\",\n \"name\": \"Bytes received on host0\",\n \"options\": {\n \"no_data_timeframe\": 20,\n \"notify_no_data\": true\n },\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"tags\": [\n \"app:webserver\",\n \"frontend\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"message\": \"You may need to add web hosts if this is consistently high.\",\n \"name\": \"Bytes received on host0\",\n \"options\": {\n \"no_data_timeframe\": 20,\n \"notify_no_data\": true\n },\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"tags\": [\n \"app:webserver\",\n \"frontend\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Monitors search",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/search?query=fugiat id&page=0&per_page=30&sort=fugiat id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"search"
],
"query": [
{
"key": "query",
"value": "fugiat id",
"description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the\nURL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2]\npage to learn more.\n\nThe query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/manage\n[2]: /monitors/manage/#find-the-monitors"
},
{
"key": "page",
"value": "0",
"description": "Page to start paginating from."
},
{
"key": "per_page",
"value": "30",
"description": "Number of monitors to return per page."
},
{
"key": "sort",
"value": "fugiat id",
"description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
}
]
},
"description": "Search and filter your monitors details."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/search?query=fugiat id&page=0&per_page=30&sort=fugiat id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"search"
],
"query": [
{
"key": "query",
"value": "fugiat id",
"description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the\nURL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2]\npage to learn more.\n\nThe query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/manage\n[2]: /monitors/manage/#find-the-monitors"
},
{
"key": "page",
"value": "0",
"description": "Page to start paginating from."
},
{
"key": "per_page",
"value": "30",
"description": "Number of monitors to return per page."
},
{
"key": "sort",
"value": "fugiat id",
"description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"counts\": {\n \"muted\": [\n {\n \"count\": 3,\n \"name\": false\n },\n {\n \"count\": 3,\n \"name\": true\n }\n ],\n \"status\": [\n {\n \"count\": 4,\n \"name\": \"No Data\"\n },\n {\n \"count\": 2,\n \"name\": \"OK\"\n }\n ],\n \"tag\": [\n {\n \"count\": 6,\n \"name\": \"service:cassandra\"\n }\n ],\n \"type\": [\n {\n \"count\": 6,\n \"name\": \"metric\"\n }\n ]\n },\n \"metadata\": {\n \"page\": 0,\n \"page_count\": 6,\n \"per_page\": 30,\n \"total_count\": 6\n },\n \"monitors\": [\n {\n \"classification\": \"metric\",\n \"creator\": {\n \"handle\": \"john@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"id\": 2699850,\n \"last_triggered_ts\": null,\n \"metrics\": [\n \"system.cpu.user\"\n ],\n \"name\": \"Cassandra CPU is high on {{host.name}} in {{availability-zone.name}}\",\n \"notifications\": [\n {\n \"handle\": \"jane@datadoghq.com\",\n \"name\": \"Jane Doe\"\n }\n ],\n \"org_id\": 1234,\n \"quality_issues\": [\n \"broken_at_handle\",\n \"noisy_monitor\"\n ],\n \"scopes\": [\n \"!availability-zone:us-east-1c\",\n \"name:cassandra\"\n ],\n \"status\": \"No Data\",\n \"tags\": [\n \"service:cassandra\"\n ],\n \"type\": \"query alert\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/search?query=fugiat id&page=0&per_page=30&sort=fugiat id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"search"
],
"query": [
{
"key": "query",
"value": "fugiat id",
"description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the\nURL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2]\npage to learn more.\n\nThe query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/manage\n[2]: /monitors/manage/#find-the-monitors"
},
{
"key": "page",
"value": "0",
"description": "Page to start paginating from."
},
{
"key": "per_page",
"value": "30",
"description": "Number of monitors to return per page."
},
{
"key": "sort",
"value": "fugiat id",
"description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/search?query=fugiat id&page=0&per_page=30&sort=fugiat id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"search"
],
"query": [
{
"key": "query",
"value": "fugiat id",
"description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the\nURL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2]\npage to learn more.\n\nThe query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/manage\n[2]: /monitors/manage/#find-the-monitors"
},
{
"key": "page",
"value": "0",
"description": "Page to start paginating from."
},
{
"key": "per_page",
"value": "30",
"description": "Number of monitors to return per page."
},
{
"key": "sort",
"value": "fugiat id",
"description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/search?query=fugiat id&page=0&per_page=30&sort=fugiat id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"search"
],
"query": [
{
"key": "query",
"value": "fugiat id",
"description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the\nURL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2]\npage to learn more.\n\nThe query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/manage\n[2]: /monitors/manage/#find-the-monitors"
},
{
"key": "page",
"value": "0",
"description": "Page to start paginating from."
},
{
"key": "per_page",
"value": "30",
"description": "Number of monitors to return per page."
},
{
"key": "sort",
"value": "fugiat id",
"description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Unmute a monitor",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/unmute?scope=role:db&all_scopes=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"unmute"
],
"query": [
{
"key": "scope",
"value": "role:db",
"description": "The scope to apply the mute to.\nFor example, if your alert is grouped by `{host}`, you might mute `host:app1`."
},
{
"key": "all_scopes",
"value": "false",
"description": "Clear muting across all scopes. Default is `false`."
}
],
"variable": [
{
"key": "monitor_id",
"value": "92403352"
}
]
},
"description": "Unmute the specified monitor."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/unmute?scope=role:db&all_scopes=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"unmute"
],
"query": [
{
"key": "scope",
"value": "role:db",
"description": "The scope to apply the mute to.\nFor example, if your alert is grouped by `{host}`, you might mute `host:app1`."
},
{
"key": "all_scopes",
"value": "false",
"description": "Clear muting across all scopes. Default is `false`."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2014-02-16T14:08:29.440Z\",\n \"creator\": {\n \"email\": \"sunt exercitation voluptate\",\n \"handle\": \"ma\",\n \"name\": \"esse reprehenderit\"\n },\n \"deleted\": \"1987-05-02T07:30:02.904Z\",\n \"draft_status\": \"published\",\n \"id\": 95649884,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"et qui Excepteur\",\n \"modified\": \"1948-03-12T17:49:01.503Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"fugiat ut commodo laborum\",\n \"evaluation_delay\": -40880516,\n \"group_retention_duration\": \"dolore mollit est\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 32618451,\n \"no_data_timeframe\": -85911134,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"minim\",\n \"sit Lorem\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -29024969,\n \"renotify_statuses\": [\n \"warn\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in non si\",\n \"trigger_window\": \"ea a\"\n },\n \"thresholds\": {\n \"critical\": 34990346.50507483,\n \"critical_recovery\": -79917454.46738935,\n \"ok\": 63763340.79153466,\n \"unknown\": -53094457.55030664,\n \"warning\": -13474871.34216705,\n \"warning_recovery\": -37101064.62721461\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"et consectetur sed cillum ex\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliqua Lorem\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliquip ullamco laboris\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor adipisicing cupidatat irure\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 387761,\n \"restricted_roles\": [\n \"sint ut eu\",\n \"nisi\"\n ],\n \"state\": {\n \"groups\": {\n \"deseruntf65\": {\n \"last_nodata_ts\": 17897411,\n \"last_notified_ts\": -71309019,\n \"last_resolved_ts\": -16413311,\n \"last_triggered_ts\": 88296706,\n \"name\": \"eu aliq\",\n \"status\": \"Skipped\"\n }\n }\n },\n \"tags\": [\n \"dolore enim cillum\",\n \"laborum do\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/unmute?scope=role:db&all_scopes=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"unmute"
],
"query": [
{
"key": "scope",
"value": "role:db",
"description": "The scope to apply the mute to.\nFor example, if your alert is grouped by `{host}`, you might mute `host:app1`."
},
{
"key": "all_scopes",
"value": "false",
"description": "Clear muting across all scopes. Default is `false`."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/unmute?scope=role:db&all_scopes=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"unmute"
],
"query": [
{
"key": "scope",
"value": "role:db",
"description": "The scope to apply the mute to.\nFor example, if your alert is grouped by `{host}`, you might mute `host:app1`."
},
{
"key": "all_scopes",
"value": "false",
"description": "Clear muting across all scopes. Default is `false`."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Monitor Not Found error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/unmute?scope=role:db&all_scopes=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"unmute"
],
"query": [
{
"key": "scope",
"value": "role:db",
"description": "The scope to apply the mute to.\nFor example, if your alert is grouped by `{host}`, you might mute `host:app1`."
},
{
"key": "all_scopes",
"value": "false",
"description": "Clear muting across all scopes. Default is `false`."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/unmute?scope=role:db&all_scopes=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"unmute"
],
"query": [
{
"key": "scope",
"value": "role:db",
"description": "The scope to apply the mute to.\nFor example, if your alert is grouped by `{host}`, you might mute `host:app1`."
},
{
"key": "all_scopes",
"value": "false",
"description": "Clear muting across all scopes. Default is `false`."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all monitors",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor?group_states=alert&name=fugiat id&tags=host:host0&monitor_tags=service:my-app&with_downtimes=true&id_offset=92403352&page=0&page_size=20",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
],
"query": [
{
"key": "group_states",
"value": "alert",
"description": "When specified, shows additional information about the group states.\nChoose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "name",
"value": "fugiat id",
"description": "A string to filter monitors by name."
},
{
"key": "tags",
"value": "host:host0",
"description": "A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope.\nFor example, `host:host0`."
},
{
"key": "monitor_tags",
"value": "service:my-app",
"description": "A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors.\nTags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for each monitor."
},
{
"key": "id_offset",
"value": "92403352",
"description": "Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty."
},
{
"key": "page",
"value": "0",
"description": "The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination."
},
{
"key": "page_size",
"value": "20",
"description": "The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100."
}
]
},
"description": "Get all monitors from your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor?group_states=alert&name=fugiat id&tags=host:host0&monitor_tags=service:my-app&with_downtimes=true&id_offset=92403352&page=0&page_size=20",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
],
"query": [
{
"key": "group_states",
"value": "alert",
"description": "When specified, shows additional information about the group states.\nChoose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "name",
"value": "fugiat id",
"description": "A string to filter monitors by name."
},
{
"key": "tags",
"value": "host:host0",
"description": "A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope.\nFor example, `host:host0`."
},
{
"key": "monitor_tags",
"value": "service:my-app",
"description": "A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors.\nTags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for each monitor."
},
{
"key": "id_offset",
"value": "92403352",
"description": "Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty."
},
{
"key": "page",
"value": "0",
"description": "The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination."
},
{
"key": "page_size",
"value": "20",
"description": "The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "[\n {\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2011-12-16T11:04:41.865Z\",\n \"creator\": {\n \"email\": \"dolore labore\",\n \"handle\": \"mollit veniam ipsum\",\n \"name\": \"Duis\"\n },\n \"deleted\": \"1960-02-17T07:10:44.790Z\",\n \"draft_status\": \"published\",\n \"id\": 59674162,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"in in\",\n \"modified\": \"1987-01-25T22:23:15.711Z\",\n \"multi\": true,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"voluptate sit\",\n \"evaluation_delay\": 60471869,\n \"group_retention_duration\": \"sint laboris commodo in\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": -71691263,\n \"no_data_timeframe\": -96592069,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"proident in ipsum\",\n \"ea\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -99473754,\n \"renotify_statuses\": [\n \"alert\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"amet veniam sint aliqua\",\n \"trigger_window\": \"ea exercitation sint\"\n },\n \"thresholds\": {\n \"critical\": -60918830.63365764,\n \"critical_recovery\": -62037429.50697775,\n \"ok\": 57742604.31899324,\n \"unknown\": -19436728.861929327,\n \"warning\": 83292567.59203464,\n \"warning_recovery\": 8952345.078133032\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"culpa enim\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"adipisicing pariatur exercitation culpa\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"qui pariatur\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"d\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"No Data\",\n \"priority\": 46427980,\n \"restricted_roles\": [\n \"in dolore\",\n \"elit labore nostrud fugiat\"\n ],\n \"state\": {\n \"groups\": {\n \"nullaa9\": {\n \"last_nodata_ts\": -62885468,\n \"last_notified_ts\": 64644578,\n \"last_resolved_ts\": 90718508,\n \"last_triggered_ts\": -15668976,\n \"name\": \"in labore ut quis\",\n \"status\": \"Skipped\"\n },\n \"dolore0\": {\n \"last_nodata_ts\": -76120502,\n \"last_notified_ts\": 31132924,\n \"last_resolved_ts\": -42245505,\n \"last_triggered_ts\": -23287178,\n \"name\": \"sint ex elit ullamco\",\n \"status\": \"Warn\"\n }\n }\n },\n \"tags\": [\n \"Excepteur ea ipsum Lorem\",\n \"cupidatat i\"\n ]\n },\n {\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"1991-11-20T08:47:51.449Z\",\n \"creator\": {\n \"email\": \"exercitation id elit eu qui\",\n \"handle\": \"\",\n \"name\": \"mollit officia aute\"\n },\n \"deleted\": \"1992-05-19T10:15:37.602Z\",\n \"draft_status\": \"published\",\n \"id\": -57739998,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"dolor cillum Ut\",\n \"modified\": \"1978-05-05T06:07:20.202Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": false,\n \"enable_samples\": true,\n \"escalation_message\": \"exercitation pariatur\",\n \"evaluation_delay\": -73083567,\n \"group_retention_duration\": \"Lorem \",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 51510866,\n \"no_data_timeframe\": 64414096,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"i\",\n \"ea in\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"default\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -59850964,\n \"renotify_statuses\": [\n \"alert\",\n \"no data\"\n ],\n \"require_full_window\": true,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"veniam ut ut\",\n \"trigger_window\": \"exercitation cupidatat tempor nisi\"\n },\n \"thresholds\": {\n \"critical\": -29017973.858305335,\n \"critical_recovery\": -97336342.56762153,\n \"ok\": 89364004.81863406,\n \"unknown\": 14556512.365170911,\n \"warning\": -96407908.98407856,\n \"warning_recovery\": 85036578.70923913\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolore ut cupidatat nostrud\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"non\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"reprehenderit commodo nisi aliqua labore\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"id ipsum\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Unknown\",\n \"priority\": -34644805,\n \"restricted_roles\": [\n \"ea ullamco\",\n \"do non Ut\"\n ],\n \"state\": {\n \"groups\": {\n \"Ut_6f2\": {\n \"last_nodata_ts\": -11927625,\n \"last_notified_ts\": -85882077,\n \"last_resolved_ts\": -2848651,\n \"last_triggered_ts\": -49375298,\n \"name\": \"esse laboris\",\n \"status\": \"Unknown\"\n },\n \"id5\": {\n \"last_nodata_ts\": 13313783,\n \"last_notified_ts\": 88889845,\n \"last_resolved_ts\": 99560321,\n \"last_triggered_ts\": -40081884,\n \"name\": \"Lorem\",\n \"status\": \"No Data\"\n },\n \"pariatura\": {\n \"last_nodata_ts\": 61046500,\n \"last_notified_ts\": 73472611,\n \"last_resolved_ts\": 36289940,\n \"last_triggered_ts\": -57923433,\n \"name\": \"anim dolor ea\",\n \"status\": \"OK\"\n }\n }\n },\n \"tags\": [\n \"consect\",\n \"nulla occaecat dolor tempor\"\n ]\n }\n]"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor?group_states=alert&name=fugiat id&tags=host:host0&monitor_tags=service:my-app&with_downtimes=true&id_offset=92403352&page=0&page_size=20",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
],
"query": [
{
"key": "group_states",
"value": "alert",
"description": "When specified, shows additional information about the group states.\nChoose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "name",
"value": "fugiat id",
"description": "A string to filter monitors by name."
},
{
"key": "tags",
"value": "host:host0",
"description": "A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope.\nFor example, `host:host0`."
},
{
"key": "monitor_tags",
"value": "service:my-app",
"description": "A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors.\nTags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for each monitor."
},
{
"key": "id_offset",
"value": "92403352",
"description": "Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty."
},
{
"key": "page",
"value": "0",
"description": "The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination."
},
{
"key": "page_size",
"value": "20",
"description": "The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor?group_states=alert&name=fugiat id&tags=host:host0&monitor_tags=service:my-app&with_downtimes=true&id_offset=92403352&page=0&page_size=20",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
],
"query": [
{
"key": "group_states",
"value": "alert",
"description": "When specified, shows additional information about the group states.\nChoose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "name",
"value": "fugiat id",
"description": "A string to filter monitors by name."
},
{
"key": "tags",
"value": "host:host0",
"description": "A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope.\nFor example, `host:host0`."
},
{
"key": "monitor_tags",
"value": "service:my-app",
"description": "A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors.\nTags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for each monitor."
},
{
"key": "id_offset",
"value": "92403352",
"description": "Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty."
},
{
"key": "page",
"value": "0",
"description": "The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination."
},
{
"key": "page_size",
"value": "20",
"description": "The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor?group_states=alert&name=fugiat id&tags=host:host0&monitor_tags=service:my-app&with_downtimes=true&id_offset=92403352&page=0&page_size=20",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor"
],
"query": [
{
"key": "group_states",
"value": "alert",
"description": "When specified, shows additional information about the group states.\nChoose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "name",
"value": "fugiat id",
"description": "A string to filter monitors by name."
},
{
"key": "tags",
"value": "host:host0",
"description": "A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope.\nFor example, `host:host0`."
},
{
"key": "monitor_tags",
"value": "service:my-app",
"description": "A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors.\nTags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for each monitor."
},
{
"key": "id_offset",
"value": "92403352",
"description": "Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty."
},
{
"key": "page",
"value": "0",
"description": "The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination."
},
{
"key": "page_size",
"value": "20",
"description": "The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Monitors group search",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/groups/search?query=fugiat id&page=0&per_page=30&sort=fugiat id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"groups",
"search"
],
"query": [
{
"key": "query",
"value": "fugiat id",
"description": "After entering a search query on the [Triggered Monitors page][1], use the query parameter value in the\nURL of the page as a value for this parameter. For more information, see the [Manage Monitors documentation][2].\n\nThe query can contain any number of space-separated monitor attributes, for instance: `query=\"type:metric group_status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/triggered\n[2]: /monitors/manage/#triggered-monitors"
},
{
"key": "page",
"value": "0",
"description": "Page to start paginating from."
},
{
"key": "per_page",
"value": "30",
"description": "Number of monitors to return per page."
},
{
"key": "sort",
"value": "fugiat id",
"description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
}
]
},
"description": "Search and filter your monitor groups details."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/groups/search?query=fugiat id&page=0&per_page=30&sort=fugiat id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"groups",
"search"
],
"query": [
{
"key": "query",
"value": "fugiat id",
"description": "After entering a search query on the [Triggered Monitors page][1], use the query parameter value in the\nURL of the page as a value for this parameter. For more information, see the [Manage Monitors documentation][2].\n\nThe query can contain any number of space-separated monitor attributes, for instance: `query=\"type:metric group_status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/triggered\n[2]: /monitors/manage/#triggered-monitors"
},
{
"key": "page",
"value": "0",
"description": "Page to start paginating from."
},
{
"key": "per_page",
"value": "30",
"description": "Number of monitors to return per page."
},
{
"key": "sort",
"value": "fugiat id",
"description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"counts\": {\n \"status\": [\n {\n \"count\": 2,\n \"name\": \"OK\"\n }\n ],\n \"type\": [\n {\n \"count\": 2,\n \"name\": \"metric\"\n }\n ]\n },\n \"groups\": [\n {\n \"group\": \"*\",\n \"group_tags\": [\n \"*\"\n ],\n \"last_nodata_ts\": 0,\n \"last_triggered_ts\": 1525702966,\n \"monitor_id\": 2738266,\n \"monitor_name\": \"[demo] Cassandra disk usage is high on {{host.name}}\",\n \"status\": \"OK\"\n },\n {\n \"group\": \"*\",\n \"group_tags\": [\n \"*\"\n ],\n \"last_nodata_ts\": 0,\n \"last_triggered_ts\": 1525703008,\n \"monitor_id\": 1576648,\n \"monitor_name\": \"[demo] Disk usage is high on {{host.name}}\",\n \"status\": \"OK\"\n }\n ],\n \"metadata\": {\n \"page\": 0,\n \"page_count\": 2,\n \"per_page\": 30,\n \"total_count\": 2\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/groups/search?query=fugiat id&page=0&per_page=30&sort=fugiat id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"groups",
"search"
],
"query": [
{
"key": "query",
"value": "fugiat id",
"description": "After entering a search query on the [Triggered Monitors page][1], use the query parameter value in the\nURL of the page as a value for this parameter. For more information, see the [Manage Monitors documentation][2].\n\nThe query can contain any number of space-separated monitor attributes, for instance: `query=\"type:metric group_status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/triggered\n[2]: /monitors/manage/#triggered-monitors"
},
{
"key": "page",
"value": "0",
"description": "Page to start paginating from."
},
{
"key": "per_page",
"value": "30",
"description": "Number of monitors to return per page."
},
{
"key": "sort",
"value": "fugiat id",
"description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/groups/search?query=fugiat id&page=0&per_page=30&sort=fugiat id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"groups",
"search"
],
"query": [
{
"key": "query",
"value": "fugiat id",
"description": "After entering a search query on the [Triggered Monitors page][1], use the query parameter value in the\nURL of the page as a value for this parameter. For more information, see the [Manage Monitors documentation][2].\n\nThe query can contain any number of space-separated monitor attributes, for instance: `query=\"type:metric group_status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/triggered\n[2]: /monitors/manage/#triggered-monitors"
},
{
"key": "page",
"value": "0",
"description": "Page to start paginating from."
},
{
"key": "per_page",
"value": "30",
"description": "Number of monitors to return per page."
},
{
"key": "sort",
"value": "fugiat id",
"description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/groups/search?query=fugiat id&page=0&per_page=30&sort=fugiat id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"groups",
"search"
],
"query": [
{
"key": "query",
"value": "fugiat id",
"description": "After entering a search query on the [Triggered Monitors page][1], use the query parameter value in the\nURL of the page as a value for this parameter. For more information, see the [Manage Monitors documentation][2].\n\nThe query can contain any number of space-separated monitor attributes, for instance: `query=\"type:metric group_status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/triggered\n[2]: /monitors/manage/#triggered-monitors"
},
{
"key": "page",
"value": "0",
"description": "Page to start paginating from."
},
{
"key": "per_page",
"value": "30",
"description": "Number of monitors to return per page."
},
{
"key": "sort",
"value": "fugiat id",
"description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Mute a monitor",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/mute?scope=role:db&end=92403352",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"mute"
],
"query": [
{
"key": "scope",
"value": "role:db",
"description": "The scope to apply the mute to.\nFor example, if your alert is grouped by `{host}`, you might mute `host:app1`."
},
{
"key": "end",
"value": "92403352",
"description": "A POSIX timestamp for when the mute should end."
}
],
"variable": [
{
"key": "monitor_id",
"value": "92403352"
}
]
},
"description": "Mute the specified monitor."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/mute?scope=role:db&end=92403352",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"mute"
],
"query": [
{
"key": "scope",
"value": "role:db",
"description": "The scope to apply the mute to.\nFor example, if your alert is grouped by `{host}`, you might mute `host:app1`."
},
{
"key": "end",
"value": "92403352",
"description": "A POSIX timestamp for when the mute should end."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2014-02-16T14:08:29.440Z\",\n \"creator\": {\n \"email\": \"sunt exercitation voluptate\",\n \"handle\": \"ma\",\n \"name\": \"esse reprehenderit\"\n },\n \"deleted\": \"1987-05-02T07:30:02.904Z\",\n \"draft_status\": \"published\",\n \"id\": 95649884,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"et qui Excepteur\",\n \"modified\": \"1948-03-12T17:49:01.503Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"fugiat ut commodo laborum\",\n \"evaluation_delay\": -40880516,\n \"group_retention_duration\": \"dolore mollit est\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 32618451,\n \"no_data_timeframe\": -85911134,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"minim\",\n \"sit Lorem\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -29024969,\n \"renotify_statuses\": [\n \"warn\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in non si\",\n \"trigger_window\": \"ea a\"\n },\n \"thresholds\": {\n \"critical\": 34990346.50507483,\n \"critical_recovery\": -79917454.46738935,\n \"ok\": 63763340.79153466,\n \"unknown\": -53094457.55030664,\n \"warning\": -13474871.34216705,\n \"warning_recovery\": -37101064.62721461\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"et consectetur sed cillum ex\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliqua Lorem\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliquip ullamco laboris\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor adipisicing cupidatat irure\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 387761,\n \"restricted_roles\": [\n \"sint ut eu\",\n \"nisi\"\n ],\n \"state\": {\n \"groups\": {\n \"deseruntf65\": {\n \"last_nodata_ts\": 17897411,\n \"last_notified_ts\": -71309019,\n \"last_resolved_ts\": -16413311,\n \"last_triggered_ts\": 88296706,\n \"name\": \"eu aliq\",\n \"status\": \"Skipped\"\n }\n }\n },\n \"tags\": [\n \"dolore enim cillum\",\n \"laborum do\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/mute?scope=role:db&end=92403352",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"mute"
],
"query": [
{
"key": "scope",
"value": "role:db",
"description": "The scope to apply the mute to.\nFor example, if your alert is grouped by `{host}`, you might mute `host:app1`."
},
{
"key": "end",
"value": "92403352",
"description": "A POSIX timestamp for when the mute should end."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/mute?scope=role:db&end=92403352",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"mute"
],
"query": [
{
"key": "scope",
"value": "role:db",
"description": "The scope to apply the mute to.\nFor example, if your alert is grouped by `{host}`, you might mute `host:app1`."
},
{
"key": "end",
"value": "92403352",
"description": "A POSIX timestamp for when the mute should end."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Monitor Not Found error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/mute?scope=role:db&end=92403352",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"mute"
],
"query": [
{
"key": "scope",
"value": "role:db",
"description": "The scope to apply the mute to.\nFor example, if your alert is grouped by `{host}`, you might mute `host:app1`."
},
{
"key": "end",
"value": "92403352",
"description": "A POSIX timestamp for when the mute should end."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/mute?scope=role:db&end=92403352",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"mute"
],
"query": [
{
"key": "scope",
"value": "role:db",
"description": "The scope to apply the mute to.\nFor example, if your alert is grouped by `{host}`, you might mute `host:app1`."
},
{
"key": "end",
"value": "92403352",
"description": "A POSIX timestamp for when the mute should end."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Edit a monitor",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created\": \"1980-05-12T17:21:49.313Z\",\n \"creator\": {\n \"email\": \"est\",\n \"handle\": \"anim\",\n \"name\": \"sed irure\"\n },\n \"deleted\": \"2014-09-22T23:44:31.353Z\",\n \"draft_status\": \"published\",\n \"id\": -52934205,\n \"message\": \"sint labore aliquip in ullamco\",\n \"modified\": \"2004-04-02T00:35:59.712Z\",\n \"multi\": true,\n \"name\": \"aute Ut consectetur ea\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": true,\n \"escalation_message\": \"et voluptate anim\",\n \"evaluation_delay\": 66150672,\n \"group_retention_duration\": \"et esse minim consectetur\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 99641342,\n \"no_data_timeframe\": -42015750,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"tempor non labo\",\n \"enim eiusmod consequat amet\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"resolve\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -25771445,\n \"renotify_statuses\": [\n \"alert\",\n \"warn\"\n ],\n \"require_full_window\": true,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in et mollit\",\n \"trigger_window\": \"cillum eiusmod ea\"\n },\n \"thresholds\": {\n \"critical\": -70198793.01462278,\n \"critical_recovery\": 38952168.445656866,\n \"ok\": -21368594.260376647,\n \"unknown\": 15512193.908150509,\n \"warning\": 46475913.506750435,\n \"warning_recovery\": -11413236.319895968\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"enim commodo in\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"eu Excepteur dolor fugiat in\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aute eiusmod cupidatat labore\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"anim proident officia fugiat minim\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 38396631,\n \"query\": \"sint\",\n \"restricted_roles\": [\n \"aliquip esse ut veniam\",\n \"sit ullamco deserunt\"\n ],\n \"state\": {\n \"groups\": {\n \"velitb\": {\n \"last_nodata_ts\": 83411124,\n \"last_notified_ts\": -71236934,\n \"last_resolved_ts\": 12650780,\n \"last_triggered_ts\": 65766612,\n \"name\": \"sunt ea\",\n \"status\": \"OK\"\n },\n \"sint_160\": {\n \"last_nodata_ts\": -64072994,\n \"last_notified_ts\": 86823563,\n \"last_resolved_ts\": 98145450,\n \"last_triggered_ts\": -2647729,\n \"name\": \"nostrud Ut cillum labore\",\n \"status\": \"Unknown\"\n },\n \"laborisb_\": {\n \"last_nodata_ts\": -52713842,\n \"last_notified_ts\": 38583802,\n \"last_resolved_ts\": 14329304,\n \"last_triggered_ts\": -65368776,\n \"name\": \"consectetur est occaecat\",\n \"status\": \"Ignored\"\n }\n }\n },\n \"tags\": [\n \"non dolore\",\n \"veniam eu do labore\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"variable": [
{
"key": "monitor_id",
"value": "666486743"
}
]
},
"description": "Edit the specified monitor."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created\": \"1980-05-12T17:21:49.313Z\",\n \"creator\": {\n \"email\": \"est\",\n \"handle\": \"anim\",\n \"name\": \"sed irure\"\n },\n \"deleted\": \"2014-09-22T23:44:31.353Z\",\n \"draft_status\": \"published\",\n \"id\": -52934205,\n \"message\": \"sint labore aliquip in ullamco\",\n \"modified\": \"2004-04-02T00:35:59.712Z\",\n \"multi\": true,\n \"name\": \"aute Ut consectetur ea\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": true,\n \"escalation_message\": \"et voluptate anim\",\n \"evaluation_delay\": 66150672,\n \"group_retention_duration\": \"et esse minim consectetur\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 99641342,\n \"no_data_timeframe\": -42015750,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"tempor non labo\",\n \"enim eiusmod consequat amet\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"resolve\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -25771445,\n \"renotify_statuses\": [\n \"alert\",\n \"warn\"\n ],\n \"require_full_window\": true,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in et mollit\",\n \"trigger_window\": \"cillum eiusmod ea\"\n },\n \"thresholds\": {\n \"critical\": -70198793.01462278,\n \"critical_recovery\": 38952168.445656866,\n \"ok\": -21368594.260376647,\n \"unknown\": 15512193.908150509,\n \"warning\": 46475913.506750435,\n \"warning_recovery\": -11413236.319895968\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"enim commodo in\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"eu Excepteur dolor fugiat in\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aute eiusmod cupidatat labore\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"anim proident officia fugiat minim\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 38396631,\n \"query\": \"sint\",\n \"restricted_roles\": [\n \"aliquip esse ut veniam\",\n \"sit ullamco deserunt\"\n ],\n \"state\": {\n \"groups\": {\n \"velitb\": {\n \"last_nodata_ts\": 83411124,\n \"last_notified_ts\": -71236934,\n \"last_resolved_ts\": 12650780,\n \"last_triggered_ts\": 65766612,\n \"name\": \"sunt ea\",\n \"status\": \"OK\"\n },\n \"sint_160\": {\n \"last_nodata_ts\": -64072994,\n \"last_notified_ts\": 86823563,\n \"last_resolved_ts\": 98145450,\n \"last_triggered_ts\": -2647729,\n \"name\": \"nostrud Ut cillum labore\",\n \"status\": \"Unknown\"\n },\n \"laborisb_\": {\n \"last_nodata_ts\": -52713842,\n \"last_notified_ts\": 38583802,\n \"last_resolved_ts\": 14329304,\n \"last_triggered_ts\": -65368776,\n \"name\": \"consectetur est occaecat\",\n \"status\": \"Ignored\"\n }\n }\n },\n \"tags\": [\n \"non dolore\",\n \"veniam eu do labore\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2014-02-16T14:08:29.440Z\",\n \"creator\": {\n \"email\": \"sunt exercitation voluptate\",\n \"handle\": \"ma\",\n \"name\": \"esse reprehenderit\"\n },\n \"deleted\": \"1987-05-02T07:30:02.904Z\",\n \"draft_status\": \"published\",\n \"id\": 95649884,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"et qui Excepteur\",\n \"modified\": \"1948-03-12T17:49:01.503Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"fugiat ut commodo laborum\",\n \"evaluation_delay\": -40880516,\n \"group_retention_duration\": \"dolore mollit est\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 32618451,\n \"no_data_timeframe\": -85911134,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"minim\",\n \"sit Lorem\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -29024969,\n \"renotify_statuses\": [\n \"warn\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in non si\",\n \"trigger_window\": \"ea a\"\n },\n \"thresholds\": {\n \"critical\": 34990346.50507483,\n \"critical_recovery\": -79917454.46738935,\n \"ok\": 63763340.79153466,\n \"unknown\": -53094457.55030664,\n \"warning\": -13474871.34216705,\n \"warning_recovery\": -37101064.62721461\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"et consectetur sed cillum ex\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliqua Lorem\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliquip ullamco laboris\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor adipisicing cupidatat irure\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 387761,\n \"restricted_roles\": [\n \"sint ut eu\",\n \"nisi\"\n ],\n \"state\": {\n \"groups\": {\n \"deseruntf65\": {\n \"last_nodata_ts\": 17897411,\n \"last_notified_ts\": -71309019,\n \"last_resolved_ts\": -16413311,\n \"last_triggered_ts\": 88296706,\n \"name\": \"eu aliq\",\n \"status\": \"Skipped\"\n }\n }\n },\n \"tags\": [\n \"dolore enim cillum\",\n \"laborum do\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created\": \"1980-05-12T17:21:49.313Z\",\n \"creator\": {\n \"email\": \"est\",\n \"handle\": \"anim\",\n \"name\": \"sed irure\"\n },\n \"deleted\": \"2014-09-22T23:44:31.353Z\",\n \"draft_status\": \"published\",\n \"id\": -52934205,\n \"message\": \"sint labore aliquip in ullamco\",\n \"modified\": \"2004-04-02T00:35:59.712Z\",\n \"multi\": true,\n \"name\": \"aute Ut consectetur ea\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": true,\n \"escalation_message\": \"et voluptate anim\",\n \"evaluation_delay\": 66150672,\n \"group_retention_duration\": \"et esse minim consectetur\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 99641342,\n \"no_data_timeframe\": -42015750,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"tempor non labo\",\n \"enim eiusmod consequat amet\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"resolve\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -25771445,\n \"renotify_statuses\": [\n \"alert\",\n \"warn\"\n ],\n \"require_full_window\": true,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in et mollit\",\n \"trigger_window\": \"cillum eiusmod ea\"\n },\n \"thresholds\": {\n \"critical\": -70198793.01462278,\n \"critical_recovery\": 38952168.445656866,\n \"ok\": -21368594.260376647,\n \"unknown\": 15512193.908150509,\n \"warning\": 46475913.506750435,\n \"warning_recovery\": -11413236.319895968\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"enim commodo in\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"eu Excepteur dolor fugiat in\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aute eiusmod cupidatat labore\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"anim proident officia fugiat minim\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 38396631,\n \"query\": \"sint\",\n \"restricted_roles\": [\n \"aliquip esse ut veniam\",\n \"sit ullamco deserunt\"\n ],\n \"state\": {\n \"groups\": {\n \"velitb\": {\n \"last_nodata_ts\": 83411124,\n \"last_notified_ts\": -71236934,\n \"last_resolved_ts\": 12650780,\n \"last_triggered_ts\": 65766612,\n \"name\": \"sunt ea\",\n \"status\": \"OK\"\n },\n \"sint_160\": {\n \"last_nodata_ts\": -64072994,\n \"last_notified_ts\": 86823563,\n \"last_resolved_ts\": 98145450,\n \"last_triggered_ts\": -2647729,\n \"name\": \"nostrud Ut cillum labore\",\n \"status\": \"Unknown\"\n },\n \"laborisb_\": {\n \"last_nodata_ts\": -52713842,\n \"last_notified_ts\": 38583802,\n \"last_resolved_ts\": 14329304,\n \"last_triggered_ts\": -65368776,\n \"name\": \"consectetur est occaecat\",\n \"status\": \"Ignored\"\n }\n }\n },\n \"tags\": [\n \"non dolore\",\n \"veniam eu do labore\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created\": \"1980-05-12T17:21:49.313Z\",\n \"creator\": {\n \"email\": \"est\",\n \"handle\": \"anim\",\n \"name\": \"sed irure\"\n },\n \"deleted\": \"2014-09-22T23:44:31.353Z\",\n \"draft_status\": \"published\",\n \"id\": -52934205,\n \"message\": \"sint labore aliquip in ullamco\",\n \"modified\": \"2004-04-02T00:35:59.712Z\",\n \"multi\": true,\n \"name\": \"aute Ut consectetur ea\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": true,\n \"escalation_message\": \"et voluptate anim\",\n \"evaluation_delay\": 66150672,\n \"group_retention_duration\": \"et esse minim consectetur\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 99641342,\n \"no_data_timeframe\": -42015750,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"tempor non labo\",\n \"enim eiusmod consequat amet\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"resolve\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -25771445,\n \"renotify_statuses\": [\n \"alert\",\n \"warn\"\n ],\n \"require_full_window\": true,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in et mollit\",\n \"trigger_window\": \"cillum eiusmod ea\"\n },\n \"thresholds\": {\n \"critical\": -70198793.01462278,\n \"critical_recovery\": 38952168.445656866,\n \"ok\": -21368594.260376647,\n \"unknown\": 15512193.908150509,\n \"warning\": 46475913.506750435,\n \"warning_recovery\": -11413236.319895968\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"enim commodo in\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"eu Excepteur dolor fugiat in\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aute eiusmod cupidatat labore\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"anim proident officia fugiat minim\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 38396631,\n \"query\": \"sint\",\n \"restricted_roles\": [\n \"aliquip esse ut veniam\",\n \"sit ullamco deserunt\"\n ],\n \"state\": {\n \"groups\": {\n \"velitb\": {\n \"last_nodata_ts\": 83411124,\n \"last_notified_ts\": -71236934,\n \"last_resolved_ts\": 12650780,\n \"last_triggered_ts\": 65766612,\n \"name\": \"sunt ea\",\n \"status\": \"OK\"\n },\n \"sint_160\": {\n \"last_nodata_ts\": -64072994,\n \"last_notified_ts\": 86823563,\n \"last_resolved_ts\": 98145450,\n \"last_triggered_ts\": -2647729,\n \"name\": \"nostrud Ut cillum labore\",\n \"status\": \"Unknown\"\n },\n \"laborisb_\": {\n \"last_nodata_ts\": -52713842,\n \"last_notified_ts\": 38583802,\n \"last_resolved_ts\": 14329304,\n \"last_triggered_ts\": -65368776,\n \"name\": \"consectetur est occaecat\",\n \"status\": \"Ignored\"\n }\n }\n },\n \"tags\": [\n \"non dolore\",\n \"veniam eu do labore\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created\": \"1980-05-12T17:21:49.313Z\",\n \"creator\": {\n \"email\": \"est\",\n \"handle\": \"anim\",\n \"name\": \"sed irure\"\n },\n \"deleted\": \"2014-09-22T23:44:31.353Z\",\n \"draft_status\": \"published\",\n \"id\": -52934205,\n \"message\": \"sint labore aliquip in ullamco\",\n \"modified\": \"2004-04-02T00:35:59.712Z\",\n \"multi\": true,\n \"name\": \"aute Ut consectetur ea\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": true,\n \"escalation_message\": \"et voluptate anim\",\n \"evaluation_delay\": 66150672,\n \"group_retention_duration\": \"et esse minim consectetur\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 99641342,\n \"no_data_timeframe\": -42015750,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"tempor non labo\",\n \"enim eiusmod consequat amet\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"resolve\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -25771445,\n \"renotify_statuses\": [\n \"alert\",\n \"warn\"\n ],\n \"require_full_window\": true,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in et mollit\",\n \"trigger_window\": \"cillum eiusmod ea\"\n },\n \"thresholds\": {\n \"critical\": -70198793.01462278,\n \"critical_recovery\": 38952168.445656866,\n \"ok\": -21368594.260376647,\n \"unknown\": 15512193.908150509,\n \"warning\": 46475913.506750435,\n \"warning_recovery\": -11413236.319895968\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"enim commodo in\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"eu Excepteur dolor fugiat in\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aute eiusmod cupidatat labore\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"anim proident officia fugiat minim\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 38396631,\n \"query\": \"sint\",\n \"restricted_roles\": [\n \"aliquip esse ut veniam\",\n \"sit ullamco deserunt\"\n ],\n \"state\": {\n \"groups\": {\n \"velitb\": {\n \"last_nodata_ts\": 83411124,\n \"last_notified_ts\": -71236934,\n \"last_resolved_ts\": 12650780,\n \"last_triggered_ts\": 65766612,\n \"name\": \"sunt ea\",\n \"status\": \"OK\"\n },\n \"sint_160\": {\n \"last_nodata_ts\": -64072994,\n \"last_notified_ts\": 86823563,\n \"last_resolved_ts\": 98145450,\n \"last_triggered_ts\": -2647729,\n \"name\": \"nostrud Ut cillum labore\",\n \"status\": \"Unknown\"\n },\n \"laborisb_\": {\n \"last_nodata_ts\": -52713842,\n \"last_notified_ts\": 38583802,\n \"last_resolved_ts\": 14329304,\n \"last_triggered_ts\": -65368776,\n \"name\": \"consectetur est occaecat\",\n \"status\": \"Ignored\"\n }\n }\n },\n \"tags\": [\n \"non dolore\",\n \"veniam eu do labore\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Monitor Not Found error",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created\": \"1980-05-12T17:21:49.313Z\",\n \"creator\": {\n \"email\": \"est\",\n \"handle\": \"anim\",\n \"name\": \"sed irure\"\n },\n \"deleted\": \"2014-09-22T23:44:31.353Z\",\n \"draft_status\": \"published\",\n \"id\": -52934205,\n \"message\": \"sint labore aliquip in ullamco\",\n \"modified\": \"2004-04-02T00:35:59.712Z\",\n \"multi\": true,\n \"name\": \"aute Ut consectetur ea\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": true,\n \"escalation_message\": \"et voluptate anim\",\n \"evaluation_delay\": 66150672,\n \"group_retention_duration\": \"et esse minim consectetur\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 99641342,\n \"no_data_timeframe\": -42015750,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"tempor non labo\",\n \"enim eiusmod consequat amet\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"resolve\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -25771445,\n \"renotify_statuses\": [\n \"alert\",\n \"warn\"\n ],\n \"require_full_window\": true,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in et mollit\",\n \"trigger_window\": \"cillum eiusmod ea\"\n },\n \"thresholds\": {\n \"critical\": -70198793.01462278,\n \"critical_recovery\": 38952168.445656866,\n \"ok\": -21368594.260376647,\n \"unknown\": 15512193.908150509,\n \"warning\": 46475913.506750435,\n \"warning_recovery\": -11413236.319895968\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"enim commodo in\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"eu Excepteur dolor fugiat in\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aute eiusmod cupidatat labore\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"anim proident officia fugiat minim\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 38396631,\n \"query\": \"sint\",\n \"restricted_roles\": [\n \"aliquip esse ut veniam\",\n \"sit ullamco deserunt\"\n ],\n \"state\": {\n \"groups\": {\n \"velitb\": {\n \"last_nodata_ts\": 83411124,\n \"last_notified_ts\": -71236934,\n \"last_resolved_ts\": 12650780,\n \"last_triggered_ts\": 65766612,\n \"name\": \"sunt ea\",\n \"status\": \"OK\"\n },\n \"sint_160\": {\n \"last_nodata_ts\": -64072994,\n \"last_notified_ts\": 86823563,\n \"last_resolved_ts\": 98145450,\n \"last_triggered_ts\": -2647729,\n \"name\": \"nostrud Ut cillum labore\",\n \"status\": \"Unknown\"\n },\n \"laborisb_\": {\n \"last_nodata_ts\": -52713842,\n \"last_notified_ts\": 38583802,\n \"last_resolved_ts\": 14329304,\n \"last_triggered_ts\": -65368776,\n \"name\": \"consectetur est occaecat\",\n \"status\": \"Ignored\"\n }\n }\n },\n \"tags\": [\n \"non dolore\",\n \"veniam eu do labore\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created\": \"1980-05-12T17:21:49.313Z\",\n \"creator\": {\n \"email\": \"est\",\n \"handle\": \"anim\",\n \"name\": \"sed irure\"\n },\n \"deleted\": \"2014-09-22T23:44:31.353Z\",\n \"draft_status\": \"published\",\n \"id\": -52934205,\n \"message\": \"sint labore aliquip in ullamco\",\n \"modified\": \"2004-04-02T00:35:59.712Z\",\n \"multi\": true,\n \"name\": \"aute Ut consectetur ea\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": true,\n \"escalation_message\": \"et voluptate anim\",\n \"evaluation_delay\": 66150672,\n \"group_retention_duration\": \"et esse minim consectetur\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 99641342,\n \"no_data_timeframe\": -42015750,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"tempor non labo\",\n \"enim eiusmod consequat amet\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"resolve\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -25771445,\n \"renotify_statuses\": [\n \"alert\",\n \"warn\"\n ],\n \"require_full_window\": true,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in et mollit\",\n \"trigger_window\": \"cillum eiusmod ea\"\n },\n \"thresholds\": {\n \"critical\": -70198793.01462278,\n \"critical_recovery\": 38952168.445656866,\n \"ok\": -21368594.260376647,\n \"unknown\": 15512193.908150509,\n \"warning\": 46475913.506750435,\n \"warning_recovery\": -11413236.319895968\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"enim commodo in\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"eu Excepteur dolor fugiat in\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aute eiusmod cupidatat labore\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"anim proident officia fugiat minim\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 38396631,\n \"query\": \"sint\",\n \"restricted_roles\": [\n \"aliquip esse ut veniam\",\n \"sit ullamco deserunt\"\n ],\n \"state\": {\n \"groups\": {\n \"velitb\": {\n \"last_nodata_ts\": 83411124,\n \"last_notified_ts\": -71236934,\n \"last_resolved_ts\": 12650780,\n \"last_triggered_ts\": 65766612,\n \"name\": \"sunt ea\",\n \"status\": \"OK\"\n },\n \"sint_160\": {\n \"last_nodata_ts\": -64072994,\n \"last_notified_ts\": 86823563,\n \"last_resolved_ts\": 98145450,\n \"last_triggered_ts\": -2647729,\n \"name\": \"nostrud Ut cillum labore\",\n \"status\": \"Unknown\"\n },\n \"laborisb_\": {\n \"last_nodata_ts\": -52713842,\n \"last_notified_ts\": 38583802,\n \"last_resolved_ts\": 14329304,\n \"last_triggered_ts\": -65368776,\n \"name\": \"consectetur est occaecat\",\n \"status\": \"Ignored\"\n }\n }\n },\n \"tags\": [\n \"non dolore\",\n \"veniam eu do labore\"\n ],\n \"type\": \"query alert\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a monitor's details",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id?group_states=fugiat id&with_downtimes=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"query": [
{
"key": "group_states",
"value": "fugiat id",
"description": "When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for the monitor."
}
],
"variable": [
{
"key": "monitor_id",
"value": "666486743"
}
]
},
"description": "Get details about the specified monitor from your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id?group_states=fugiat id&with_downtimes=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"query": [
{
"key": "group_states",
"value": "fugiat id",
"description": "When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for the monitor."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2014-02-16T14:08:29.440Z\",\n \"creator\": {\n \"email\": \"sunt exercitation voluptate\",\n \"handle\": \"ma\",\n \"name\": \"esse reprehenderit\"\n },\n \"deleted\": \"1987-05-02T07:30:02.904Z\",\n \"draft_status\": \"published\",\n \"id\": 95649884,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"et qui Excepteur\",\n \"modified\": \"1948-03-12T17:49:01.503Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"fugiat ut commodo laborum\",\n \"evaluation_delay\": -40880516,\n \"group_retention_duration\": \"dolore mollit est\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 32618451,\n \"no_data_timeframe\": -85911134,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"minim\",\n \"sit Lorem\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -29024969,\n \"renotify_statuses\": [\n \"warn\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in non si\",\n \"trigger_window\": \"ea a\"\n },\n \"thresholds\": {\n \"critical\": 34990346.50507483,\n \"critical_recovery\": -79917454.46738935,\n \"ok\": 63763340.79153466,\n \"unknown\": -53094457.55030664,\n \"warning\": -13474871.34216705,\n \"warning_recovery\": -37101064.62721461\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"et consectetur sed cillum ex\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliqua Lorem\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliquip ullamco laboris\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor adipisicing cupidatat irure\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 387761,\n \"restricted_roles\": [\n \"sint ut eu\",\n \"nisi\"\n ],\n \"state\": {\n \"groups\": {\n \"deseruntf65\": {\n \"last_nodata_ts\": 17897411,\n \"last_notified_ts\": -71309019,\n \"last_resolved_ts\": -16413311,\n \"last_triggered_ts\": 88296706,\n \"name\": \"eu aliq\",\n \"status\": \"Skipped\"\n }\n }\n },\n \"tags\": [\n \"dolore enim cillum\",\n \"laborum do\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id?group_states=fugiat id&with_downtimes=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"query": [
{
"key": "group_states",
"value": "fugiat id",
"description": "When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for the monitor."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id?group_states=fugiat id&with_downtimes=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"query": [
{
"key": "group_states",
"value": "fugiat id",
"description": "When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for the monitor."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Monitor Not Found error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id?group_states=fugiat id&with_downtimes=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"query": [
{
"key": "group_states",
"value": "fugiat id",
"description": "When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for the monitor."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id?group_states=fugiat id&with_downtimes=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"query": [
{
"key": "group_states",
"value": "fugiat id",
"description": "When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`."
},
{
"key": "with_downtimes",
"value": "true",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for the monitor."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a monitor",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id?force=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"query": [
{
"key": "force",
"value": "false",
"description": "Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor)."
}
],
"variable": [
{
"key": "monitor_id",
"value": "666486743"
}
]
},
"description": "Delete the specified monitor"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id?force=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"query": [
{
"key": "force",
"value": "false",
"description": "Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor)."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"deleted_monitor_id\": 666486743\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id?force=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"query": [
{
"key": "force",
"value": "false",
"description": "Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor)."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id?force=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"query": [
{
"key": "force",
"value": "false",
"description": "Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor)."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id?force=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"query": [
{
"key": "force",
"value": "false",
"description": "Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor)."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item not found error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id?force=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"query": [
{
"key": "force",
"value": "false",
"description": "Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor)."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id?force=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id"
],
"query": [
{
"key": "force",
"value": "false",
"description": "Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor)."
}
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Check if a monitor can be deleted",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/can_delete?monitor_ids=666486743,666486743",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"can_delete"
],
"query": [
{
"key": "monitor_ids",
"value": "666486743,666486743",
"description": "(Required) The IDs of the monitor to check."
}
]
},
"description": "Check if the given monitors can be deleted."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/can_delete?monitor_ids=666486743,666486743",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"can_delete"
],
"query": [
{
"key": "monitor_ids",
"value": "666486743,666486743",
"description": "(Required) The IDs of the monitor to check."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {},\n \"errors\": {\n \"do3\": [\n \"irure sed\",\n \"Excepteur do\"\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/can_delete?monitor_ids=666486743,666486743",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"can_delete"
],
"query": [
{
"key": "monitor_ids",
"value": "666486743,666486743",
"description": "(Required) The IDs of the monitor to check."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/can_delete?monitor_ids=666486743,666486743",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"can_delete"
],
"query": [
{
"key": "monitor_ids",
"value": "666486743,666486743",
"description": "(Required) The IDs of the monitor to check."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Deletion conflict error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/can_delete?monitor_ids=666486743,666486743",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"can_delete"
],
"query": [
{
"key": "monitor_ids",
"value": "666486743,666486743",
"description": "(Required) The IDs of the monitor to check."
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {},\n \"errors\": {\n \"do3\": [\n \"irure sed\",\n \"Excepteur do\"\n ]\n }\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/can_delete?monitor_ids=666486743,666486743",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"can_delete"
],
"query": [
{
"key": "monitor_ids",
"value": "666486743,666486743",
"description": "(Required) The IDs of the monitor to check."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Validate a monitor",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2014-02-16T14:08:29.440Z\",\n \"creator\": {\n \"email\": \"sunt exercitation voluptate\",\n \"handle\": \"ma\",\n \"name\": \"esse reprehenderit\"\n },\n \"deleted\": \"1987-05-02T07:30:02.904Z\",\n \"draft_status\": \"published\",\n \"id\": 95649884,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"et qui Excepteur\",\n \"modified\": \"1948-03-12T17:49:01.503Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"fugiat ut commodo laborum\",\n \"evaluation_delay\": -40880516,\n \"group_retention_duration\": \"dolore mollit est\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 32618451,\n \"no_data_timeframe\": -85911134,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"minim\",\n \"sit Lorem\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -29024969,\n \"renotify_statuses\": [\n \"warn\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in non si\",\n \"trigger_window\": \"ea a\"\n },\n \"thresholds\": {\n \"critical\": 34990346.50507483,\n \"critical_recovery\": -79917454.46738935,\n \"ok\": 63763340.79153466,\n \"unknown\": -53094457.55030664,\n \"warning\": -13474871.34216705,\n \"warning_recovery\": -37101064.62721461\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"et consectetur sed cillum ex\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliqua Lorem\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliquip ullamco laboris\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor adipisicing cupidatat irure\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 387761,\n \"restricted_roles\": [\n \"sint ut eu\",\n \"nisi\"\n ],\n \"state\": {\n \"groups\": {\n \"deseruntf65\": {\n \"last_nodata_ts\": 17897411,\n \"last_notified_ts\": -71309019,\n \"last_resolved_ts\": -16413311,\n \"last_triggered_ts\": 88296706,\n \"name\": \"eu aliq\",\n \"status\": \"Skipped\"\n }\n }\n },\n \"tags\": [\n \"dolore enim cillum\",\n \"laborum do\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/validate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"validate"
]
},
"description": "Validate the monitor provided in the request.\n\n**Note**: Log monitors require an unscoped App Key."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2014-02-16T14:08:29.440Z\",\n \"creator\": {\n \"email\": \"sunt exercitation voluptate\",\n \"handle\": \"ma\",\n \"name\": \"esse reprehenderit\"\n },\n \"deleted\": \"1987-05-02T07:30:02.904Z\",\n \"draft_status\": \"published\",\n \"id\": 95649884,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"et qui Excepteur\",\n \"modified\": \"1948-03-12T17:49:01.503Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"fugiat ut commodo laborum\",\n \"evaluation_delay\": -40880516,\n \"group_retention_duration\": \"dolore mollit est\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 32618451,\n \"no_data_timeframe\": -85911134,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"minim\",\n \"sit Lorem\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -29024969,\n \"renotify_statuses\": [\n \"warn\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in non si\",\n \"trigger_window\": \"ea a\"\n },\n \"thresholds\": {\n \"critical\": 34990346.50507483,\n \"critical_recovery\": -79917454.46738935,\n \"ok\": 63763340.79153466,\n \"unknown\": -53094457.55030664,\n \"warning\": -13474871.34216705,\n \"warning_recovery\": -37101064.62721461\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"et consectetur sed cillum ex\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliqua Lorem\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliquip ullamco laboris\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor adipisicing cupidatat irure\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 387761,\n \"restricted_roles\": [\n \"sint ut eu\",\n \"nisi\"\n ],\n \"state\": {\n \"groups\": {\n \"deseruntf65\": {\n \"last_nodata_ts\": 17897411,\n \"last_notified_ts\": -71309019,\n \"last_resolved_ts\": -16413311,\n \"last_triggered_ts\": 88296706,\n \"name\": \"eu aliq\",\n \"status\": \"Skipped\"\n }\n }\n },\n \"tags\": [\n \"dolore enim cillum\",\n \"laborum do\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/validate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"validate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Invalid JSON",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2014-02-16T14:08:29.440Z\",\n \"creator\": {\n \"email\": \"sunt exercitation voluptate\",\n \"handle\": \"ma\",\n \"name\": \"esse reprehenderit\"\n },\n \"deleted\": \"1987-05-02T07:30:02.904Z\",\n \"draft_status\": \"published\",\n \"id\": 95649884,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"et qui Excepteur\",\n \"modified\": \"1948-03-12T17:49:01.503Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"fugiat ut commodo laborum\",\n \"evaluation_delay\": -40880516,\n \"group_retention_duration\": \"dolore mollit est\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 32618451,\n \"no_data_timeframe\": -85911134,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"minim\",\n \"sit Lorem\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -29024969,\n \"renotify_statuses\": [\n \"warn\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in non si\",\n \"trigger_window\": \"ea a\"\n },\n \"thresholds\": {\n \"critical\": 34990346.50507483,\n \"critical_recovery\": -79917454.46738935,\n \"ok\": 63763340.79153466,\n \"unknown\": -53094457.55030664,\n \"warning\": -13474871.34216705,\n \"warning_recovery\": -37101064.62721461\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"et consectetur sed cillum ex\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliqua Lorem\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliquip ullamco laboris\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor adipisicing cupidatat irure\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 387761,\n \"restricted_roles\": [\n \"sint ut eu\",\n \"nisi\"\n ],\n \"state\": {\n \"groups\": {\n \"deseruntf65\": {\n \"last_nodata_ts\": 17897411,\n \"last_notified_ts\": -71309019,\n \"last_resolved_ts\": -16413311,\n \"last_triggered_ts\": 88296706,\n \"name\": \"eu aliq\",\n \"status\": \"Skipped\"\n }\n }\n },\n \"tags\": [\n \"dolore enim cillum\",\n \"laborum do\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/validate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"validate"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2014-02-16T14:08:29.440Z\",\n \"creator\": {\n \"email\": \"sunt exercitation voluptate\",\n \"handle\": \"ma\",\n \"name\": \"esse reprehenderit\"\n },\n \"deleted\": \"1987-05-02T07:30:02.904Z\",\n \"draft_status\": \"published\",\n \"id\": 95649884,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"et qui Excepteur\",\n \"modified\": \"1948-03-12T17:49:01.503Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"fugiat ut commodo laborum\",\n \"evaluation_delay\": -40880516,\n \"group_retention_duration\": \"dolore mollit est\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 32618451,\n \"no_data_timeframe\": -85911134,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"minim\",\n \"sit Lorem\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -29024969,\n \"renotify_statuses\": [\n \"warn\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in non si\",\n \"trigger_window\": \"ea a\"\n },\n \"thresholds\": {\n \"critical\": 34990346.50507483,\n \"critical_recovery\": -79917454.46738935,\n \"ok\": 63763340.79153466,\n \"unknown\": -53094457.55030664,\n \"warning\": -13474871.34216705,\n \"warning_recovery\": -37101064.62721461\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"et consectetur sed cillum ex\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliqua Lorem\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliquip ullamco laboris\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor adipisicing cupidatat irure\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 387761,\n \"restricted_roles\": [\n \"sint ut eu\",\n \"nisi\"\n ],\n \"state\": {\n \"groups\": {\n \"deseruntf65\": {\n \"last_nodata_ts\": 17897411,\n \"last_notified_ts\": -71309019,\n \"last_resolved_ts\": -16413311,\n \"last_triggered_ts\": 88296706,\n \"name\": \"eu aliq\",\n \"status\": \"Skipped\"\n }\n }\n },\n \"tags\": [\n \"dolore enim cillum\",\n \"laborum do\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/validate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"validate"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2014-02-16T14:08:29.440Z\",\n \"creator\": {\n \"email\": \"sunt exercitation voluptate\",\n \"handle\": \"ma\",\n \"name\": \"esse reprehenderit\"\n },\n \"deleted\": \"1987-05-02T07:30:02.904Z\",\n \"draft_status\": \"published\",\n \"id\": 95649884,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"et qui Excepteur\",\n \"modified\": \"1948-03-12T17:49:01.503Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"fugiat ut commodo laborum\",\n \"evaluation_delay\": -40880516,\n \"group_retention_duration\": \"dolore mollit est\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 32618451,\n \"no_data_timeframe\": -85911134,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"minim\",\n \"sit Lorem\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -29024969,\n \"renotify_statuses\": [\n \"warn\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in non si\",\n \"trigger_window\": \"ea a\"\n },\n \"thresholds\": {\n \"critical\": 34990346.50507483,\n \"critical_recovery\": -79917454.46738935,\n \"ok\": 63763340.79153466,\n \"unknown\": -53094457.55030664,\n \"warning\": -13474871.34216705,\n \"warning_recovery\": -37101064.62721461\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"et consectetur sed cillum ex\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliqua Lorem\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliquip ullamco laboris\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor adipisicing cupidatat irure\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 387761,\n \"restricted_roles\": [\n \"sint ut eu\",\n \"nisi\"\n ],\n \"state\": {\n \"groups\": {\n \"deseruntf65\": {\n \"last_nodata_ts\": 17897411,\n \"last_notified_ts\": -71309019,\n \"last_resolved_ts\": -16413311,\n \"last_triggered_ts\": 88296706,\n \"name\": \"eu aliq\",\n \"status\": \"Skipped\"\n }\n }\n },\n \"tags\": [\n \"dolore enim cillum\",\n \"laborum do\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/validate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
"validate"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Validate an existing monitor",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2014-02-16T14:08:29.440Z\",\n \"creator\": {\n \"email\": \"sunt exercitation voluptate\",\n \"handle\": \"ma\",\n \"name\": \"esse reprehenderit\"\n },\n \"deleted\": \"1987-05-02T07:30:02.904Z\",\n \"draft_status\": \"published\",\n \"id\": 95649884,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"et qui Excepteur\",\n \"modified\": \"1948-03-12T17:49:01.503Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"fugiat ut commodo laborum\",\n \"evaluation_delay\": -40880516,\n \"group_retention_duration\": \"dolore mollit est\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 32618451,\n \"no_data_timeframe\": -85911134,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"minim\",\n \"sit Lorem\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -29024969,\n \"renotify_statuses\": [\n \"warn\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in non si\",\n \"trigger_window\": \"ea a\"\n },\n \"thresholds\": {\n \"critical\": 34990346.50507483,\n \"critical_recovery\": -79917454.46738935,\n \"ok\": 63763340.79153466,\n \"unknown\": -53094457.55030664,\n \"warning\": -13474871.34216705,\n \"warning_recovery\": -37101064.62721461\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"et consectetur sed cillum ex\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliqua Lorem\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliquip ullamco laboris\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor adipisicing cupidatat irure\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 387761,\n \"restricted_roles\": [\n \"sint ut eu\",\n \"nisi\"\n ],\n \"state\": {\n \"groups\": {\n \"deseruntf65\": {\n \"last_nodata_ts\": 17897411,\n \"last_notified_ts\": -71309019,\n \"last_resolved_ts\": -16413311,\n \"last_triggered_ts\": 88296706,\n \"name\": \"eu aliq\",\n \"status\": \"Skipped\"\n }\n }\n },\n \"tags\": [\n \"dolore enim cillum\",\n \"laborum do\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/validate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"validate"
],
"variable": [
{
"key": "monitor_id",
"value": "666486743"
}
]
},
"description": "Validate the monitor provided in the request."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2014-02-16T14:08:29.440Z\",\n \"creator\": {\n \"email\": \"sunt exercitation voluptate\",\n \"handle\": \"ma\",\n \"name\": \"esse reprehenderit\"\n },\n \"deleted\": \"1987-05-02T07:30:02.904Z\",\n \"draft_status\": \"published\",\n \"id\": 95649884,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"et qui Excepteur\",\n \"modified\": \"1948-03-12T17:49:01.503Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"fugiat ut commodo laborum\",\n \"evaluation_delay\": -40880516,\n \"group_retention_duration\": \"dolore mollit est\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 32618451,\n \"no_data_timeframe\": -85911134,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"minim\",\n \"sit Lorem\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -29024969,\n \"renotify_statuses\": [\n \"warn\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in non si\",\n \"trigger_window\": \"ea a\"\n },\n \"thresholds\": {\n \"critical\": 34990346.50507483,\n \"critical_recovery\": -79917454.46738935,\n \"ok\": 63763340.79153466,\n \"unknown\": -53094457.55030664,\n \"warning\": -13474871.34216705,\n \"warning_recovery\": -37101064.62721461\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"et consectetur sed cillum ex\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliqua Lorem\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliquip ullamco laboris\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor adipisicing cupidatat irure\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 387761,\n \"restricted_roles\": [\n \"sint ut eu\",\n \"nisi\"\n ],\n \"state\": {\n \"groups\": {\n \"deseruntf65\": {\n \"last_nodata_ts\": 17897411,\n \"last_notified_ts\": -71309019,\n \"last_resolved_ts\": -16413311,\n \"last_triggered_ts\": 88296706,\n \"name\": \"eu aliq\",\n \"status\": \"Skipped\"\n }\n }\n },\n \"tags\": [\n \"dolore enim cillum\",\n \"laborum do\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/validate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"validate"
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Invalid JSON",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2014-02-16T14:08:29.440Z\",\n \"creator\": {\n \"email\": \"sunt exercitation voluptate\",\n \"handle\": \"ma\",\n \"name\": \"esse reprehenderit\"\n },\n \"deleted\": \"1987-05-02T07:30:02.904Z\",\n \"draft_status\": \"published\",\n \"id\": 95649884,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"et qui Excepteur\",\n \"modified\": \"1948-03-12T17:49:01.503Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"fugiat ut commodo laborum\",\n \"evaluation_delay\": -40880516,\n \"group_retention_duration\": \"dolore mollit est\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 32618451,\n \"no_data_timeframe\": -85911134,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"minim\",\n \"sit Lorem\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -29024969,\n \"renotify_statuses\": [\n \"warn\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in non si\",\n \"trigger_window\": \"ea a\"\n },\n \"thresholds\": {\n \"critical\": 34990346.50507483,\n \"critical_recovery\": -79917454.46738935,\n \"ok\": 63763340.79153466,\n \"unknown\": -53094457.55030664,\n \"warning\": -13474871.34216705,\n \"warning_recovery\": -37101064.62721461\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"et consectetur sed cillum ex\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliqua Lorem\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliquip ullamco laboris\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor adipisicing cupidatat irure\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 387761,\n \"restricted_roles\": [\n \"sint ut eu\",\n \"nisi\"\n ],\n \"state\": {\n \"groups\": {\n \"deseruntf65\": {\n \"last_nodata_ts\": 17897411,\n \"last_notified_ts\": -71309019,\n \"last_resolved_ts\": -16413311,\n \"last_triggered_ts\": 88296706,\n \"name\": \"eu aliq\",\n \"status\": \"Skipped\"\n }\n }\n },\n \"tags\": [\n \"dolore enim cillum\",\n \"laborum do\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/validate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"validate"
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2014-02-16T14:08:29.440Z\",\n \"creator\": {\n \"email\": \"sunt exercitation voluptate\",\n \"handle\": \"ma\",\n \"name\": \"esse reprehenderit\"\n },\n \"deleted\": \"1987-05-02T07:30:02.904Z\",\n \"draft_status\": \"published\",\n \"id\": 95649884,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"et qui Excepteur\",\n \"modified\": \"1948-03-12T17:49:01.503Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"fugiat ut commodo laborum\",\n \"evaluation_delay\": -40880516,\n \"group_retention_duration\": \"dolore mollit est\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 32618451,\n \"no_data_timeframe\": -85911134,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"minim\",\n \"sit Lorem\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -29024969,\n \"renotify_statuses\": [\n \"warn\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in non si\",\n \"trigger_window\": \"ea a\"\n },\n \"thresholds\": {\n \"critical\": 34990346.50507483,\n \"critical_recovery\": -79917454.46738935,\n \"ok\": 63763340.79153466,\n \"unknown\": -53094457.55030664,\n \"warning\": -13474871.34216705,\n \"warning_recovery\": -37101064.62721461\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"et consectetur sed cillum ex\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliqua Lorem\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliquip ullamco laboris\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor adipisicing cupidatat irure\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 387761,\n \"restricted_roles\": [\n \"sint ut eu\",\n \"nisi\"\n ],\n \"state\": {\n \"groups\": {\n \"deseruntf65\": {\n \"last_nodata_ts\": 17897411,\n \"last_notified_ts\": -71309019,\n \"last_resolved_ts\": -16413311,\n \"last_triggered_ts\": 88296706,\n \"name\": \"eu aliq\",\n \"status\": \"Skipped\"\n }\n }\n },\n \"tags\": [\n \"dolore enim cillum\",\n \"laborum do\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/validate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"validate"
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"query alert\",\n \"query\": \"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100\",\n \"created\": \"2014-02-16T14:08:29.440Z\",\n \"creator\": {\n \"email\": \"sunt exercitation voluptate\",\n \"handle\": \"ma\",\n \"name\": \"esse reprehenderit\"\n },\n \"deleted\": \"1987-05-02T07:30:02.904Z\",\n \"draft_status\": \"published\",\n \"id\": 95649884,\n \"matching_downtimes\": [\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n },\n {\n \"id\": 1625,\n \"end\": 1412792983,\n \"scope\": [\n \"env:staging\"\n ],\n \"start\": 1412792983\n }\n ],\n \"message\": \"et qui Excepteur\",\n \"modified\": \"1948-03-12T17:49:01.503Z\",\n \"multi\": false,\n \"name\": \"My monitor\",\n \"options\": {\n \"aggregation\": {\n \"group_by\": \"host\",\n \"metric\": \"metrics.name\",\n \"type\": \"count\"\n },\n \"enable_logs_sample\": true,\n \"enable_samples\": false,\n \"escalation_message\": \"fugiat ut commodo laborum\",\n \"evaluation_delay\": -40880516,\n \"group_retention_duration\": \"dolore mollit est\",\n \"include_tags\": true,\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"new_group_delay\": 32618451,\n \"no_data_timeframe\": -85911134,\n \"notification_preset_name\": \"show_all\",\n \"notify_audit\": false,\n \"notify_by\": [\n \"minim\",\n \"sit Lorem\"\n ],\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"renotify_interval\": null,\n \"renotify_occurrences\": -29024969,\n \"renotify_statuses\": [\n \"warn\",\n \"warn\"\n ],\n \"require_full_window\": false,\n \"scheduling_options\": {\n \"custom_schedule\": {\n \"recurrences\": [\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n },\n {\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\",\n \"start\": \"2023-08-31T16:30:00\",\n \"timezone\": \"Europe/Paris\"\n }\n ]\n },\n \"evaluation_window\": {\n \"day_starts\": \"04:00\",\n \"hour_starts\": 0,\n \"month_starts\": 1,\n \"timezone\": \"Europe/Paris\"\n }\n },\n \"threshold_windows\": {\n \"recovery_window\": \"in non si\",\n \"trigger_window\": \"ea a\"\n },\n \"thresholds\": {\n \"critical\": 34990346.50507483,\n \"critical_recovery\": -79917454.46738935,\n \"ok\": 63763340.79153466,\n \"unknown\": -53094457.55030664,\n \"warning\": -13474871.34216705,\n \"warning_recovery\": -37101064.62721461\n },\n \"timeout_h\": null,\n \"variables\": [\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"et consectetur sed cillum ex\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliqua Lorem\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n },\n {\n \"data_source\": \"rum\",\n \"compute\": {\n \"aggregation\": \"avg\",\n \"interval\": 60000,\n \"metric\": \"@duration\"\n },\n \"name\": \"query_errors\",\n \"group_by\": [\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"aliquip ullamco laboris\",\n \"order\": \"desc\"\n }\n },\n {\n \"facet\": \"status\",\n \"limit\": 10,\n \"sort\": {\n \"aggregation\": \"avg\",\n \"metric\": \"dolor adipisicing cupidatat irure\",\n \"order\": \"desc\"\n }\n }\n ],\n \"indexes\": [\n \"days-3\",\n \"days-7\"\n ],\n \"search\": {\n \"query\": \"service:query\"\n }\n }\n ]\n },\n \"overall_state\": \"Warn\",\n \"priority\": 387761,\n \"restricted_roles\": [\n \"sint ut eu\",\n \"nisi\"\n ],\n \"state\": {\n \"groups\": {\n \"deseruntf65\": {\n \"last_nodata_ts\": 17897411,\n \"last_notified_ts\": -71309019,\n \"last_resolved_ts\": -16413311,\n \"last_triggered_ts\": 88296706,\n \"name\": \"eu aliq\",\n \"status\": \"Skipped\"\n }\n }\n },\n \"tags\": [\n \"dolore enim cillum\",\n \"laborum do\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/monitor/:monitor_id/validate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"monitor",
":monitor_id",
"validate"
],
"variable": [
{
"key": "monitor_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a monitor configuration policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id",
"value": "00000000-0000-1234-0000-000000000000"
}
]
},
"description": "Get a monitor configuration policy by `policy_id`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n },\n \"policy_type\": \"tag\"\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"monitor-config-policy\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all monitor configuration policies",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy"
]
},
"description": "Get all monitor configuration policies."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n },\n \"policy_type\": \"tag\"\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"monitor-config-policy\"\n },\n {\n \"attributes\": {\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n },\n \"policy_type\": \"tag\"\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"monitor-config-policy\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a monitor configuration policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy"
]
},
"description": "Create a monitor configuration policy."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n },\n \"policy_type\": \"tag\"\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"monitor-config-policy\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Edit a monitor configuration policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id",
"value": "00000000-0000-1234-0000-000000000000"
}
]
},
"description": "Edit a monitor configuration policy."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n },\n \"policy_type\": \"tag\"\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"monitor-config-policy\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unprocessable Entity",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"datacenter\",\n \"tag_key_required\": true,\n \"valid_tag_values\": [\n \"prod\",\n \"staging\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a monitor configuration policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id",
"value": "00000000-0000-1234-0000-000000000000"
}
]
},
"description": "Delete a monitor configuration policy."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all monitor notification rules",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule?include=created_by",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule"
],
"query": [
{
"key": "include",
"value": "created_by",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npath is `created_by`."
}
]
},
"description": "Returns a list of all monitor notification rules."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule?include=created_by",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule"
],
"query": [
{
"key": "include",
"value": "created_by",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npath is `created_by`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"2020-01-02T03:04:00.000Z\",\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n },\n \"modified\": \"2020-01-02T03:04:00.000Z\",\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ]\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"monitor-notification-rule\"\n },\n {\n \"attributes\": {\n \"created\": \"2020-01-02T03:04:00.000Z\",\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n },\n \"modified\": \"2020-01-02T03:04:00.000Z\",\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ]\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"monitor-notification-rule\"\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1982-03-25T22:02:35.119Z\",\n \"disabled\": true,\n \"email\": \"sed eu esse sunt\",\n \"handle\": \"culpa ex veniam\",\n \"icon\": \"do veniam nostrud\",\n \"mfa_enabled\": false,\n \"modified_at\": \"2003-01-19T14:38:38.799Z\",\n \"name\": \"in\",\n \"service_account\": false,\n \"status\": \"sunt occaecat\",\n \"title\": \"eiusmod\",\n \"verified\": true\n },\n \"id\": \"minim sint ut exercitation\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2017-12-13T20:38:22.552Z\",\n \"disabled\": true,\n \"email\": \"exercitation in\",\n \"handle\": \"ea qui Lorem est\",\n \"icon\": \"laborum exercitation in mollit\",\n \"mfa_enabled\": true,\n \"modified_at\": \"1981-12-27T21:10:12.290Z\",\n \"name\": \"adipisicing occaecat Duis sit proident\",\n \"service_account\": false,\n \"status\": \"ipsum reprehenderit dolor pariatur\",\n \"title\": \"Excepteur aliqua sed\",\n \"verified\": true\n },\n \"id\": \"sunt tempor\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule?include=created_by",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule"
],
"query": [
{
"key": "include",
"value": "created_by",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npath is `created_by`."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule?include=created_by",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule"
],
"query": [
{
"key": "include",
"value": "created_by",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npath is `created_by`."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a monitor notification rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id?include=created_by",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"query": [
{
"key": "include",
"value": "created_by",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npath is `created_by`."
}
],
"variable": [
{
"key": "rule_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Returns a monitor notification rule by `rule_id`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id?include=created_by",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"query": [
{
"key": "include",
"value": "created_by",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npath is `created_by`."
}
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created\": \"2020-01-02T03:04:00.000Z\",\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n },\n \"modified\": \"2020-01-02T03:04:00.000Z\",\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ]\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"monitor-notification-rule\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1959-09-02T03:48:05.537Z\",\n \"disabled\": false,\n \"email\": \"voluptate veniam\",\n \"handle\": \"consectetur ex\",\n \"icon\": \"dolore enim elit\",\n \"mfa_enabled\": true,\n \"modified_at\": \"1969-12-30T05:54:44.826Z\",\n \"name\": \"esse minim occaecat commodo\",\n \"service_account\": false,\n \"status\": \"ad ut fugiat amet\",\n \"title\": \"\",\n \"verified\": false\n },\n \"id\": \"sit in\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2002-11-26T01:18:25.583Z\",\n \"disabled\": true,\n \"email\": \"labo\",\n \"handle\": \"aliquip dolore\",\n \"icon\": \"anim\",\n \"mfa_enabled\": false,\n \"modified_at\": \"2013-04-11T11:33:36.906Z\",\n \"name\": \"adipisicing ad irure ullamco\",\n \"service_account\": true,\n \"status\": \"est minim aliquip ad\",\n \"title\": \"in sint Excepteur veniam\",\n \"verified\": false\n },\n \"id\": \"esse anim \",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id?include=created_by",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"query": [
{
"key": "include",
"value": "created_by",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npath is `created_by`."
}
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id?include=created_by",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"query": [
{
"key": "include",
"value": "created_by",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npath is `created_by`."
}
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id?include=created_by",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"query": [
{
"key": "include",
"value": "created_by",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npath is `created_by`."
}
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a monitor notification rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ],\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n }\n },\n \"type\": \"monitor-notification-rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule"
]
},
"description": "Creates a monitor notification rule."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ],\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n }\n },\n \"type\": \"monitor-notification-rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created\": \"2020-01-02T03:04:00.000Z\",\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n },\n \"modified\": \"2020-01-02T03:04:00.000Z\",\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ]\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"monitor-notification-rule\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1959-09-02T03:48:05.537Z\",\n \"disabled\": false,\n \"email\": \"voluptate veniam\",\n \"handle\": \"consectetur ex\",\n \"icon\": \"dolore enim elit\",\n \"mfa_enabled\": true,\n \"modified_at\": \"1969-12-30T05:54:44.826Z\",\n \"name\": \"esse minim occaecat commodo\",\n \"service_account\": false,\n \"status\": \"ad ut fugiat amet\",\n \"title\": \"\",\n \"verified\": false\n },\n \"id\": \"sit in\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2002-11-26T01:18:25.583Z\",\n \"disabled\": true,\n \"email\": \"labo\",\n \"handle\": \"aliquip dolore\",\n \"icon\": \"anim\",\n \"mfa_enabled\": false,\n \"modified_at\": \"2013-04-11T11:33:36.906Z\",\n \"name\": \"adipisicing ad irure ullamco\",\n \"service_account\": true,\n \"status\": \"est minim aliquip ad\",\n \"title\": \"in sint Excepteur veniam\",\n \"verified\": false\n },\n \"id\": \"esse anim \",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ],\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n }\n },\n \"type\": \"monitor-notification-rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ],\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n }\n },\n \"type\": \"monitor-notification-rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ],\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n }\n },\n \"type\": \"monitor-notification-rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a monitor notification rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"attributes\": {\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ],\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n }\n },\n \"type\": \"monitor-notification-rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"variable": [
{
"key": "rule_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Updates a monitor notification rule by `rule_id`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"attributes\": {\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ],\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n }\n },\n \"type\": \"monitor-notification-rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created\": \"2020-01-02T03:04:00.000Z\",\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n },\n \"modified\": \"2020-01-02T03:04:00.000Z\",\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ]\n },\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"monitor-notification-rule\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1959-09-02T03:48:05.537Z\",\n \"disabled\": false,\n \"email\": \"voluptate veniam\",\n \"handle\": \"consectetur ex\",\n \"icon\": \"dolore enim elit\",\n \"mfa_enabled\": true,\n \"modified_at\": \"1969-12-30T05:54:44.826Z\",\n \"name\": \"esse minim occaecat commodo\",\n \"service_account\": false,\n \"status\": \"ad ut fugiat amet\",\n \"title\": \"\",\n \"verified\": false\n },\n \"id\": \"sit in\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2002-11-26T01:18:25.583Z\",\n \"disabled\": true,\n \"email\": \"labo\",\n \"handle\": \"aliquip dolore\",\n \"icon\": \"anim\",\n \"mfa_enabled\": false,\n \"modified_at\": \"2013-04-11T11:33:36.906Z\",\n \"name\": \"adipisicing ad irure ullamco\",\n \"service_account\": true,\n \"status\": \"est minim aliquip ad\",\n \"title\": \"in sint Excepteur veniam\",\n \"verified\": false\n },\n \"id\": \"esse anim \",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"attributes\": {\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ],\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n }\n },\n \"type\": \"monitor-notification-rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"attributes\": {\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ],\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n }\n },\n \"type\": \"monitor-notification-rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"attributes\": {\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ],\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n }\n },\n \"type\": \"monitor-notification-rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-1234-0000-000000000000\",\n \"attributes\": {\n \"name\": \"A notification rule name\",\n \"recipients\": [\n \"slack-test-channel\",\n \"jira-test\"\n ],\n \"filter\": {\n \"tags\": [\n \"team:product\",\n \"host:abc\"\n ]\n }\n },\n \"type\": \"monitor-notification-rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a monitor notification rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"variable": [
{
"key": "rule_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Deletes a monitor notification rule by `rule_id`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/notification_rule/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"notification_rule",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "[Monitors](https://docs.datadoghq.com/monitors) allow you to watch a metric or check that you care about and\nnotifies your team when a defined threshold has exceeded.\n\nFor more information, see [Creating Monitors](https://docs.datadoghq.com/monitors/create/types/) and\n[Tag Policies](https://docs.datadoghq.com/monitors/settings/).",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Network Device Monitoring",
"item": [
{
"name": "Get the list of devices",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/devices?page[number]=0&page[size]=10&sort=status&filter[tag]=status:ok",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"devices"
],
"query": [
{
"key": "page[number]",
"value": "0",
"description": "The page number to fetch."
},
{
"key": "page[size]",
"value": "10",
"description": "The number of devices to return per page."
},
{
"key": "sort",
"value": "status",
"description": "The field to sort the devices by."
},
{
"key": "filter[tag]",
"value": "status:ok",
"description": "Filter devices by tag."
}
]
},
"description": "Get the list of devices."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/devices?page[number]=0&page[size]=10&sort=status&filter[tag]=status:ok",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"devices"
],
"query": [
{
"key": "page[number]",
"value": "0",
"description": "The page number to fetch."
},
{
"key": "page[size]",
"value": "10",
"description": "The number of devices to return per page."
},
{
"key": "sort",
"value": "status",
"description": "The field to sort the devices by."
},
{
"key": "filter[tag]",
"value": "status:ok",
"description": "Filter devices by tag."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"description\": \"a device monitored with NDM\",\n \"device_type\": \"other\",\n \"integration\": \"snmp\",\n \"interface_statuses\": {\n \"down\": 1,\n \"off\": 2,\n \"up\": 12,\n \"warning\": 5\n },\n \"ip_address\": \"1.2.3.4\",\n \"location\": \"paris\",\n \"model\": \"xx-123\",\n \"name\": \"example device\",\n \"os_hostname\": \"est i\",\n \"os_name\": \"example OS\",\n \"os_version\": \"1.0.2\",\n \"ping_status\": \"unmonitored\",\n \"product_name\": \"example device\",\n \"serial_number\": \"X12345\",\n \"status\": \"ok\",\n \"subnet\": \"1.2.3.4/24\",\n \"sys_object_id\": \"1.3.6.1.4.1.99999\",\n \"tags\": [\n \"device_ip:1.2.3.4\",\n \"device_id:example:1.2.3.4\"\n ],\n \"vendor\": \"example vendor\",\n \"version\": \"1.2.3\"\n },\n \"id\": \"example:1.2.3.4\",\n \"type\": \"pariatur ve\"\n },\n {\n \"attributes\": {\n \"description\": \"a device monitored with NDM\",\n \"device_type\": \"other\",\n \"integration\": \"snmp\",\n \"interface_statuses\": {\n \"down\": 1,\n \"off\": 2,\n \"up\": 12,\n \"warning\": 5\n },\n \"ip_address\": \"1.2.3.4\",\n \"location\": \"paris\",\n \"model\": \"xx-123\",\n \"name\": \"example device\",\n \"os_hostname\": \"minim elit culpa\",\n \"os_name\": \"example OS\",\n \"os_version\": \"1.0.2\",\n \"ping_status\": \"unmonitored\",\n \"product_name\": \"example device\",\n \"serial_number\": \"X12345\",\n \"status\": \"ok\",\n \"subnet\": \"1.2.3.4/24\",\n \"sys_object_id\": \"1.3.6.1.4.1.99999\",\n \"tags\": [\n \"device_ip:1.2.3.4\",\n \"device_id:example:1.2.3.4\"\n ],\n \"vendor\": \"example vendor\",\n \"version\": \"1.2.3\"\n },\n \"id\": \"example:1.2.3.4\",\n \"type\": \"anim ex\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_filtered_count\": 1\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/devices?page[number]=0&page[size]=10&sort=status&filter[tag]=status:ok",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"devices"
],
"query": [
{
"key": "page[number]",
"value": "0",
"description": "The page number to fetch."
},
{
"key": "page[size]",
"value": "10",
"description": "The number of devices to return per page."
},
{
"key": "sort",
"value": "status",
"description": "The field to sort the devices by."
},
{
"key": "filter[tag]",
"value": "status:ok",
"description": "Filter devices by tag."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/devices?page[number]=0&page[size]=10&sort=status&filter[tag]=status:ok",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"devices"
],
"query": [
{
"key": "page[number]",
"value": "0",
"description": "The page number to fetch."
},
{
"key": "page[size]",
"value": "10",
"description": "The number of devices to return per page."
},
{
"key": "sort",
"value": "status",
"description": "The field to sort the devices by."
},
{
"key": "filter[tag]",
"value": "status:ok",
"description": "Filter devices by tag."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/devices?page[number]=0&page[size]=10&sort=status&filter[tag]=status:ok",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"devices"
],
"query": [
{
"key": "page[number]",
"value": "0",
"description": "The page number to fetch."
},
{
"key": "page[size]",
"value": "10",
"description": "The number of devices to return per page."
},
{
"key": "sort",
"value": "status",
"description": "The field to sort the devices by."
},
{
"key": "filter[tag]",
"value": "status:ok",
"description": "Filter devices by tag."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get the device details",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/devices/:device_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"devices",
":device_id"
],
"variable": [
{
"key": "device_id",
"value": "example:1.2.3.4"
}
]
},
"description": "Get the device details."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/devices/:device_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"devices",
":device_id"
],
"variable": [
{
"key": "device_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"a device monitored with NDM\",\n \"device_type\": \"other\",\n \"integration\": \"snmp\",\n \"ip_address\": \"1.2.3.4\",\n \"location\": \"paris\",\n \"model\": \"xx-123\",\n \"name\": \"example device\",\n \"os_hostname\": \"1.0.2\",\n \"os_name\": \"example OS\",\n \"os_version\": \"1.0.2\",\n \"ping_status\": \"unmonitored\",\n \"product_name\": \"example device\",\n \"serial_number\": \"X12345\",\n \"status\": \"ok\",\n \"subnet\": \"1.2.3.4/24\",\n \"sys_object_id\": \"1.3.6.1.4.1.99999\",\n \"tags\": [\n \"device_ip:1.2.3.4\",\n \"device_id:example:1.2.3.4\"\n ],\n \"vendor\": \"example vendor\",\n \"version\": \"1.2.3\"\n },\n \"id\": \"example:1.2.3.4\",\n \"type\": \"dolore\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/devices/:device_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"devices",
":device_id"
],
"variable": [
{
"key": "device_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/devices/:device_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"devices",
":device_id"
],
"variable": [
{
"key": "device_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/devices/:device_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"devices",
":device_id"
],
"variable": [
{
"key": "device_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get the list of interfaces of the device",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/interfaces?device_id=example:1.2.3.4",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"interfaces"
],
"query": [
{
"key": "device_id",
"value": "example:1.2.3.4",
"description": "(Required) The ID of the device to get interfaces from."
}
]
},
"description": "Get the list of interfaces of the device."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/interfaces?device_id=example:1.2.3.4",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"interfaces"
],
"query": [
{
"key": "device_id",
"value": "example:1.2.3.4",
"description": "(Required) The ID of the device to get interfaces from."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"alias\": \"interface_0\",\n \"description\": \"a network interface\",\n \"index\": 0,\n \"mac_address\": \"00:00:00:00:00:00\",\n \"name\": \"if0\",\n \"status\": \"up\"\n },\n \"id\": \"example:1.2.3.4:99\",\n \"type\": \"nisi\"\n },\n {\n \"attributes\": {\n \"alias\": \"interface_0\",\n \"description\": \"a network interface\",\n \"index\": 0,\n \"mac_address\": \"00:00:00:00:00:00\",\n \"name\": \"if0\",\n \"status\": \"up\"\n },\n \"id\": \"example:1.2.3.4:99\",\n \"type\": \"dolor Ut ut mollit\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/interfaces?device_id=example:1.2.3.4",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"interfaces"
],
"query": [
{
"key": "device_id",
"value": "example:1.2.3.4",
"description": "(Required) The ID of the device to get interfaces from."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/interfaces?device_id=example:1.2.3.4",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"interfaces"
],
"query": [
{
"key": "device_id",
"value": "example:1.2.3.4",
"description": "(Required) The ID of the device to get interfaces from."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get the list of tags for a device",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/tags/devices/:device_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"tags",
"devices",
":device_id"
],
"variable": [
{
"key": "device_id",
"value": "example:1.2.3.4"
}
]
},
"description": "Get the list of tags for a device."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/tags/devices/:device_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"tags",
"devices",
":device_id"
],
"variable": [
{
"key": "device_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"tags\": [\n \"tag:test\",\n \"tag:testbis\"\n ]\n },\n \"id\": \"example:1.2.3.4\",\n \"type\": \"occaecat ea aute dolor\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/tags/devices/:device_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"tags",
"devices",
":device_id"
],
"variable": [
{
"key": "device_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/tags/devices/:device_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"tags",
"devices",
":device_id"
],
"variable": [
{
"key": "device_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/tags/devices/:device_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"tags",
"devices",
":device_id"
],
"variable": [
{
"key": "device_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update the tags for a device",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"tags\": [\n \"tag:test\",\n \"tag:testbis\"\n ]\n },\n \"id\": \"example:1.2.3.4\",\n \"type\": \"occaecat ea aute dolor\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/tags/devices/:device_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"tags",
"devices",
":device_id"
],
"variable": [
{
"key": "device_id",
"value": "example:1.2.3.4"
}
]
},
"description": "Update the tags for a device."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"tags\": [\n \"tag:test\",\n \"tag:testbis\"\n ]\n },\n \"id\": \"example:1.2.3.4\",\n \"type\": \"occaecat ea aute dolor\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/tags/devices/:device_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"tags",
"devices",
":device_id"
],
"variable": [
{
"key": "device_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"tags\": [\n \"tag:test\",\n \"tag:testbis\"\n ]\n },\n \"id\": \"example:1.2.3.4\",\n \"type\": \"occaecat ea aute dolor\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"tags\": [\n \"tag:test\",\n \"tag:testbis\"\n ]\n },\n \"id\": \"example:1.2.3.4\",\n \"type\": \"occaecat ea aute dolor\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/tags/devices/:device_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"tags",
"devices",
":device_id"
],
"variable": [
{
"key": "device_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"tags\": [\n \"tag:test\",\n \"tag:testbis\"\n ]\n },\n \"id\": \"example:1.2.3.4\",\n \"type\": \"occaecat ea aute dolor\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/tags/devices/:device_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"tags",
"devices",
":device_id"
],
"variable": [
{
"key": "device_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"tags\": [\n \"tag:test\",\n \"tag:testbis\"\n ]\n },\n \"id\": \"example:1.2.3.4\",\n \"type\": \"occaecat ea aute dolor\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ndm/tags/devices/:device_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ndm",
"tags",
"devices",
":device_id"
],
"variable": [
{
"key": "device_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "The Network Device Monitoring API allows you to fetch devices and interfaces and their attributes. See the [Network Device Monitoring page](https://docs.datadoghq.com/network_monitoring/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Notebooks",
"item": [
{
"name": "Create a notebook",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"line\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"dog_classic\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
]
},
"description": "Create a notebook using the specified options."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"line\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"dog_classic\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": 123456,\n \"type\": \"notebooks\",\n \"attributes\": {\n \"cells\": [\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n },\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n }\n ],\n \"time\": {\n \"live_span\": \"1h\"\n },\n \"name\": \"Example Notebook\",\n \"author\": {\n \"created_at\": \"1953-03-28T11:41:14.995Z\",\n \"disabled\": false,\n \"email\": \"magna ut\",\n \"handle\": \"incididunt\",\n \"icon\": \"anim dolore reprehenderit\",\n \"name\": \"cupidatat\",\n \"status\": \"non aliqua incididunt et eu\",\n \"title\": \"et commodo sunt minim\",\n \"verified\": false\n },\n \"created\": \"2021-02-24T23:14:15.173964+00:00\",\n \"metadata\": {\n \"is_template\": false,\n \"take_snapshots\": false,\n \"type\": \"investigation\"\n },\n \"modified\": \"2021-02-24T23:15:23.274966+00:00\",\n \"status\": \"published\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"line\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"dog_classic\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"line\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"dog_classic\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"line\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"dog_classic\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all notebooks",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
],
"query": [
{
"key": "author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks created by the given `author_handle`.",
"disabled": true
},
{
"key": "exclude_author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks not created by the given `author_handle`.",
"disabled": true
},
{
"key": "start",
"value": "0",
"description": "The index of the first notebook you want returned.",
"disabled": true
},
{
"key": "count",
"value": "5",
"description": "The number of notebooks to be returned.",
"disabled": true
},
{
"key": "sort_field",
"value": "modified",
"description": "Sort by field `modified`, `name`, or `created`.",
"disabled": true
},
{
"key": "sort_dir",
"value": "desc",
"description": "Sort by direction `asc` or `desc`.",
"disabled": true
},
{
"key": "query",
"value": "postmortem",
"description": "Return only notebooks with `query` string in notebook name or author handle.",
"disabled": true
},
{
"key": "include_cells",
"value": "false",
"description": "Value of `false` excludes the `cells` and global `time` for each notebook.",
"disabled": true
},
{
"key": "is_template",
"value": "false",
"description": "True value returns only template notebooks. Default is false (returns only non-template notebooks).",
"disabled": true
},
{
"key": "type",
"value": "investigation",
"description": "If type is provided, returns only notebooks with that metadata type. Default does not have type filtering.",
"disabled": true
}
]
},
"description": "Get all notebooks. This can also be used to search for notebooks with a particular `query` in the notebook\n`name` or author `handle`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
],
"query": [
{
"key": "author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks created by the given `author_handle`.",
"disabled": true
},
{
"key": "exclude_author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks not created by the given `author_handle`.",
"disabled": true
},
{
"key": "start",
"value": "0",
"description": "The index of the first notebook you want returned.",
"disabled": true
},
{
"key": "count",
"value": "5",
"description": "The number of notebooks to be returned.",
"disabled": true
},
{
"key": "sort_field",
"value": "modified",
"description": "Sort by field `modified`, `name`, or `created`.",
"disabled": true
},
{
"key": "sort_dir",
"value": "desc",
"description": "Sort by direction `asc` or `desc`.",
"disabled": true
},
{
"key": "query",
"value": "postmortem",
"description": "Return only notebooks with `query` string in notebook name or author handle.",
"disabled": true
},
{
"key": "include_cells",
"value": "false",
"description": "Value of `false` excludes the `cells` and global `time` for each notebook.",
"disabled": true
},
{
"key": "is_template",
"value": "false",
"description": "True value returns only template notebooks. Default is false (returns only non-template notebooks).",
"disabled": true
},
{
"key": "type",
"value": "investigation",
"description": "If type is provided, returns only notebooks with that metadata type. Default does not have type filtering.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": 123456,\n \"type\": \"notebooks\",\n \"attributes\": {\n \"name\": \"Example Notebook\",\n \"author\": {\n \"created_at\": \"2011-12-12T10:52:03.592Z\",\n \"disabled\": true,\n \"email\": \"sunt sint Excepteur\",\n \"handle\": \"te\",\n \"icon\": \"cillum aliqua\",\n \"name\": \"in\",\n \"status\": \"est nisi la\",\n \"title\": \"officia tempor\",\n \"verified\": true\n },\n \"cells\": [\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n },\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n }\n ],\n \"created\": \"2021-02-24T23:14:15.173964+00:00\",\n \"metadata\": {\n \"is_template\": false,\n \"take_snapshots\": false,\n \"type\": \"investigation\"\n },\n \"modified\": \"2021-02-24T23:15:23.274966+00:00\",\n \"status\": \"published\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n }\n },\n {\n \"id\": 123456,\n \"type\": \"notebooks\",\n \"attributes\": {\n \"name\": \"Example Notebook\",\n \"author\": {\n \"created_at\": \"1956-06-22T11:49:27.925Z\",\n \"disabled\": true,\n \"email\": \"ut ullamco\",\n \"handle\": \"magna l\",\n \"icon\": \"dolor Lor\",\n \"name\": \"velit\",\n \"status\": \"mollit laboris ex\",\n \"title\": \"consequat eiusmod sit elit\",\n \"verified\": true\n },\n \"cells\": [\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n },\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n }\n ],\n \"created\": \"2021-02-24T23:14:15.173964+00:00\",\n \"metadata\": {\n \"is_template\": false,\n \"take_snapshots\": false,\n \"type\": \"investigation\"\n },\n \"modified\": \"2021-02-24T23:15:23.274966+00:00\",\n \"status\": \"published\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": -13304344,\n \"total_filtered_count\": 81448508\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
],
"query": [
{
"key": "author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks created by the given `author_handle`.",
"disabled": true
},
{
"key": "exclude_author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks not created by the given `author_handle`.",
"disabled": true
},
{
"key": "start",
"value": "0",
"description": "The index of the first notebook you want returned.",
"disabled": true
},
{
"key": "count",
"value": "5",
"description": "The number of notebooks to be returned.",
"disabled": true
},
{
"key": "sort_field",
"value": "modified",
"description": "Sort by field `modified`, `name`, or `created`.",
"disabled": true
},
{
"key": "sort_dir",
"value": "desc",
"description": "Sort by direction `asc` or `desc`.",
"disabled": true
},
{
"key": "query",
"value": "postmortem",
"description": "Return only notebooks with `query` string in notebook name or author handle.",
"disabled": true
},
{
"key": "include_cells",
"value": "false",
"description": "Value of `false` excludes the `cells` and global `time` for each notebook.",
"disabled": true
},
{
"key": "is_template",
"value": "false",
"description": "True value returns only template notebooks. Default is false (returns only non-template notebooks).",
"disabled": true
},
{
"key": "type",
"value": "investigation",
"description": "If type is provided, returns only notebooks with that metadata type. Default does not have type filtering.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
],
"query": [
{
"key": "author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks created by the given `author_handle`.",
"disabled": true
},
{
"key": "exclude_author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks not created by the given `author_handle`.",
"disabled": true
},
{
"key": "start",
"value": "0",
"description": "The index of the first notebook you want returned.",
"disabled": true
},
{
"key": "count",
"value": "5",
"description": "The number of notebooks to be returned.",
"disabled": true
},
{
"key": "sort_field",
"value": "modified",
"description": "Sort by field `modified`, `name`, or `created`.",
"disabled": true
},
{
"key": "sort_dir",
"value": "desc",
"description": "Sort by direction `asc` or `desc`.",
"disabled": true
},
{
"key": "query",
"value": "postmortem",
"description": "Return only notebooks with `query` string in notebook name or author handle.",
"disabled": true
},
{
"key": "include_cells",
"value": "false",
"description": "Value of `false` excludes the `cells` and global `time` for each notebook.",
"disabled": true
},
{
"key": "is_template",
"value": "false",
"description": "True value returns only template notebooks. Default is false (returns only non-template notebooks).",
"disabled": true
},
{
"key": "type",
"value": "investigation",
"description": "If type is provided, returns only notebooks with that metadata type. Default does not have type filtering.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
],
"query": [
{
"key": "author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks created by the given `author_handle`.",
"disabled": true
},
{
"key": "exclude_author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks not created by the given `author_handle`.",
"disabled": true
},
{
"key": "start",
"value": "0",
"description": "The index of the first notebook you want returned.",
"disabled": true
},
{
"key": "count",
"value": "5",
"description": "The number of notebooks to be returned.",
"disabled": true
},
{
"key": "sort_field",
"value": "modified",
"description": "Sort by field `modified`, `name`, or `created`.",
"disabled": true
},
{
"key": "sort_dir",
"value": "desc",
"description": "Sort by direction `asc` or `desc`.",
"disabled": true
},
{
"key": "query",
"value": "postmortem",
"description": "Return only notebooks with `query` string in notebook name or author handle.",
"disabled": true
},
{
"key": "include_cells",
"value": "false",
"description": "Value of `false` excludes the `cells` and global `time` for each notebook.",
"disabled": true
},
{
"key": "is_template",
"value": "false",
"description": "True value returns only template notebooks. Default is false (returns only non-template notebooks).",
"disabled": true
},
{
"key": "type",
"value": "investigation",
"description": "If type is provided, returns only notebooks with that metadata type. Default does not have type filtering.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a notebook",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id",
"value": "-32260706"
}
]
},
"description": "Delete a notebook using the specified ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a notebook",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some updated test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"bars\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"warm\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id",
"value": "-32260706"
}
]
},
"description": "Update a notebook using the specified ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some updated test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"bars\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"warm\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": 123456,\n \"type\": \"notebooks\",\n \"attributes\": {\n \"cells\": [\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n },\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n }\n ],\n \"time\": {\n \"live_span\": \"1h\"\n },\n \"name\": \"Example Notebook\",\n \"author\": {\n \"created_at\": \"1953-03-28T11:41:14.995Z\",\n \"disabled\": false,\n \"email\": \"magna ut\",\n \"handle\": \"incididunt\",\n \"icon\": \"anim dolore reprehenderit\",\n \"name\": \"cupidatat\",\n \"status\": \"non aliqua incididunt et eu\",\n \"title\": \"et commodo sunt minim\",\n \"verified\": false\n },\n \"created\": \"2021-02-24T23:14:15.173964+00:00\",\n \"metadata\": {\n \"is_template\": false,\n \"take_snapshots\": false,\n \"type\": \"investigation\"\n },\n \"modified\": \"2021-02-24T23:15:23.274966+00:00\",\n \"status\": \"published\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some updated test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"bars\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"warm\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some updated test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"bars\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"warm\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some updated test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"bars\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"warm\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some updated test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"bars\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"warm\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some updated test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"bars\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"warm\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a notebook",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id",
"value": "-32260706"
}
]
},
"description": "Get a notebook using the specified notebook ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": 123456,\n \"type\": \"notebooks\",\n \"attributes\": {\n \"cells\": [\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n },\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n }\n ],\n \"time\": {\n \"live_span\": \"1h\"\n },\n \"name\": \"Example Notebook\",\n \"author\": {\n \"created_at\": \"1953-03-28T11:41:14.995Z\",\n \"disabled\": false,\n \"email\": \"magna ut\",\n \"handle\": \"incididunt\",\n \"icon\": \"anim dolore reprehenderit\",\n \"name\": \"cupidatat\",\n \"status\": \"non aliqua incididunt et eu\",\n \"title\": \"et commodo sunt minim\",\n \"verified\": false\n },\n \"created\": \"2021-02-24T23:14:15.173964+00:00\",\n \"metadata\": {\n \"is_template\": false,\n \"take_snapshots\": false,\n \"type\": \"investigation\"\n },\n \"modified\": \"2021-02-24T23:15:23.274966+00:00\",\n \"status\": \"published\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Interact with your notebooks through the API to make it easier to organize, find, and\nshare all of your notebooks with your team and organization. For more information, see the\n[Notebooks documentation](https://docs.datadoghq.com/notebooks/).",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Okta Integration",
"item": [
{
"name": "List Okta accounts",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts"
]
},
"description": "List Okta accounts."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://example.okta.com/\",\n \"name\": \"Okta-Prod\",\n \"api_key\": \"qui esse Lorem\",\n \"client_id\": \"do reprehenderit\",\n \"client_secret\": \"incididunt anim aute consequat sint\"\n },\n \"id\": \"f749daaf-682e-4208-a38d-c9b43162c609\",\n \"type\": \"okta-accounts\"\n },\n {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://example.okta.com/\",\n \"name\": \"Okta-Prod\",\n \"api_key\": \"non in officia eiusmod\",\n \"client_id\": \"velit eu occaecat dolore ut\",\n \"client_secret\": \"sed ex sunt culpa\"\n },\n \"id\": \"f749daaf-682e-4208-a38d-c9b43162c609\",\n \"type\": \"okta-accounts\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Add Okta account",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://example.okta.com/\",\n \"name\": \"Okta-Prod\",\n \"api_key\": \"aute dolor magna labore\",\n \"client_id\": \"sunt\",\n \"client_secret\": \"amet labore est laboris l\"\n },\n \"type\": \"okta-accounts\",\n \"id\": \"f749daaf-682e-4208-a38d-c9b43162c609\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts"
]
},
"description": "Create an Okta account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://example.okta.com/\",\n \"name\": \"Okta-Prod\",\n \"api_key\": \"aute dolor magna labore\",\n \"client_id\": \"sunt\",\n \"client_secret\": \"amet labore est laboris l\"\n },\n \"type\": \"okta-accounts\",\n \"id\": \"f749daaf-682e-4208-a38d-c9b43162c609\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://example.okta.com/\",\n \"name\": \"Okta-Prod\",\n \"api_key\": \"voluptate eius\",\n \"client_id\": \"voluptate\",\n \"client_secret\": \"minim ullamco exercitation anim ut\"\n },\n \"type\": \"okta-accounts\",\n \"id\": \"f749daaf-682e-4208-a38d-c9b43162c609\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://example.okta.com/\",\n \"name\": \"Okta-Prod\",\n \"api_key\": \"aute dolor magna labore\",\n \"client_id\": \"sunt\",\n \"client_secret\": \"amet labore est laboris l\"\n },\n \"type\": \"okta-accounts\",\n \"id\": \"f749daaf-682e-4208-a38d-c9b43162c609\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://example.okta.com/\",\n \"name\": \"Okta-Prod\",\n \"api_key\": \"aute dolor magna labore\",\n \"client_id\": \"sunt\",\n \"client_secret\": \"amet labore est laboris l\"\n },\n \"type\": \"okta-accounts\",\n \"id\": \"f749daaf-682e-4208-a38d-c9b43162c609\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://example.okta.com/\",\n \"name\": \"Okta-Prod\",\n \"api_key\": \"aute dolor magna labore\",\n \"client_id\": \"sunt\",\n \"client_secret\": \"amet labore est laboris l\"\n },\n \"type\": \"okta-accounts\",\n \"id\": \"f749daaf-682e-4208-a38d-c9b43162c609\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://example.okta.com/\",\n \"name\": \"Okta-Prod\",\n \"api_key\": \"aute dolor magna labore\",\n \"client_id\": \"sunt\",\n \"client_secret\": \"amet labore est laboris l\"\n },\n \"type\": \"okta-accounts\",\n \"id\": \"f749daaf-682e-4208-a38d-c9b43162c609\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get Okta account",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Get an Okta account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://example.okta.com/\",\n \"name\": \"Okta-Prod\",\n \"api_key\": \"voluptate eius\",\n \"client_id\": \"voluptate\",\n \"client_secret\": \"minim ullamco exercitation anim ut\"\n },\n \"type\": \"okta-accounts\",\n \"id\": \"f749daaf-682e-4208-a38d-c9b43162c609\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update Okta account",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://dev-test.okta.com/\",\n \"api_key\": \"aliqua in eiusmod m\",\n \"client_id\": \"ad irure esse velit labore\",\n \"client_secret\": \"elit ea id ex reprehenderit\"\n },\n \"type\": \"okta-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Update an Okta account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://dev-test.okta.com/\",\n \"api_key\": \"aliqua in eiusmod m\",\n \"client_id\": \"ad irure esse velit labore\",\n \"client_secret\": \"elit ea id ex reprehenderit\"\n },\n \"type\": \"okta-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://example.okta.com/\",\n \"name\": \"Okta-Prod\",\n \"api_key\": \"voluptate eius\",\n \"client_id\": \"voluptate\",\n \"client_secret\": \"minim ullamco exercitation anim ut\"\n },\n \"type\": \"okta-accounts\",\n \"id\": \"f749daaf-682e-4208-a38d-c9b43162c609\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://dev-test.okta.com/\",\n \"api_key\": \"aliqua in eiusmod m\",\n \"client_id\": \"ad irure esse velit labore\",\n \"client_secret\": \"elit ea id ex reprehenderit\"\n },\n \"type\": \"okta-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://dev-test.okta.com/\",\n \"api_key\": \"aliqua in eiusmod m\",\n \"client_id\": \"ad irure esse velit labore\",\n \"client_secret\": \"elit ea id ex reprehenderit\"\n },\n \"type\": \"okta-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://dev-test.okta.com/\",\n \"api_key\": \"aliqua in eiusmod m\",\n \"client_id\": \"ad irure esse velit labore\",\n \"client_secret\": \"elit ea id ex reprehenderit\"\n },\n \"type\": \"okta-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"auth_method\": \"oauth\",\n \"domain\": \"https://dev-test.okta.com/\",\n \"api_key\": \"aliqua in eiusmod m\",\n \"client_id\": \"ad irure esse velit labore\",\n \"client_secret\": \"elit ea id ex reprehenderit\"\n },\n \"type\": \"okta-accounts\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete Okta account",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete an Okta account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integrations/okta/accounts/:account_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integrations",
"okta",
"accounts",
":account_id"
],
"variable": [
{
"key": "account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Configure your [Datadog Okta integration](https://docs.datadoghq.com/integrations/okta/) directly through the Datadog API.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "On-Call",
"item": [
{
"name": "Create on-call schedule",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"layers\": [\n {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"days\": 1\n },\n \"members\": [\n {\n \"user\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\"\n }\n }\n ],\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n }\n ],\n \"name\": \"On-Call Schedule\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
]
},
"description": "Create a new on-call schedule"
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"layers\": [\n {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"days\": 1\n },\n \"members\": [\n {\n \"user\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\"\n }\n }\n ],\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n }\n ],\n \"name\": \"On-Call Schedule\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"On-Call Schedule\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"relationships\": {\n \"layers\": {\n \"data\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"type\": \"layers\"\n }\n ]\n },\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"avatar\": \"\",\n \"description\": \"Team 1 description\",\n \"handle\": \"team1\",\n \"name\": \"Team 1\"\n },\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n },\n {\n \"attributes\": {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"days\": 1\n },\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n },\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"relationships\": {\n \"members\": {\n \"data\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000002\",\n \"type\": \"members\"\n }\n ]\n }\n },\n \"type\": \"layers\"\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000002\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"members\"\n },\n {\n \"attributes\": {\n \"email\": \"foo@bar.com\",\n \"name\": \"User 1\"\n },\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"layers\": [\n {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"days\": 1\n },\n \"members\": [\n {\n \"user\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\"\n }\n }\n ],\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n }\n ],\n \"name\": \"On-Call Schedule\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"layers\": [\n {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"days\": 1\n },\n \"members\": [\n {\n \"user\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\"\n }\n }\n ],\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n }\n ],\n \"name\": \"On-Call Schedule\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"layers\": [\n {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"days\": 1\n },\n \"members\": [\n {\n \"user\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\"\n }\n }\n ],\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n }\n ],\n \"name\": \"On-Call Schedule\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"layers\": [\n {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"days\": 1\n },\n \"members\": [\n {\n \"user\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\"\n }\n }\n ],\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n }\n ],\n \"name\": \"On-Call Schedule\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get on-call schedule",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
],
"variable": [
{
"key": "schedule_id",
"value": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
}
]
},
"description": "Get an on-call schedule"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"On-Call Schedule\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"relationships\": {\n \"layers\": {\n \"data\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"type\": \"layers\"\n }\n ]\n },\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"avatar\": \"\",\n \"description\": \"Team 1 description\",\n \"handle\": \"team1\",\n \"name\": \"Team 1\"\n },\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n },\n {\n \"attributes\": {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"days\": 1\n },\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n },\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"relationships\": {\n \"members\": {\n \"data\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000002\",\n \"type\": \"members\"\n }\n ]\n }\n },\n \"type\": \"layers\"\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000002\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"members\"\n },\n {\n \"attributes\": {\n \"email\": \"foo@bar.com\",\n \"name\": \"User 1\"\n },\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete on-call schedule",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"variable": [
{
"key": "schedule_id",
"value": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
}
]
},
"description": "Delete an on-call schedule"
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update on-call schedule",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"layers\": [\n {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"seconds\": 300\n },\n \"members\": [\n {\n \"user\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\"\n }\n }\n ],\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n }\n ],\n \"name\": \"On-Call Schedule Updated\",\n \"tags\": [\n \"tag1\",\n \"tag2\",\n \"tag3\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
],
"variable": [
{
"key": "schedule_id",
"value": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
}
]
},
"description": "Update a new on-call schedule"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"layers\": [\n {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"seconds\": 300\n },\n \"members\": [\n {\n \"user\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\"\n }\n }\n ],\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n }\n ],\n \"name\": \"On-Call Schedule Updated\",\n \"tags\": [\n \"tag1\",\n \"tag2\",\n \"tag3\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"On-Call Schedule\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"relationships\": {\n \"layers\": {\n \"data\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"type\": \"layers\"\n }\n ]\n },\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"avatar\": \"\",\n \"description\": \"Team 1 description\",\n \"handle\": \"team1\",\n \"name\": \"Team 1\"\n },\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n },\n {\n \"attributes\": {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"days\": 1\n },\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n },\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"relationships\": {\n \"members\": {\n \"data\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000002\",\n \"type\": \"members\"\n }\n ]\n }\n },\n \"type\": \"layers\"\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000002\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"members\"\n },\n {\n \"attributes\": {\n \"email\": \"foo@bar.com\",\n \"name\": \"User 1\"\n },\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"layers\": [\n {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"seconds\": 300\n },\n \"members\": [\n {\n \"user\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\"\n }\n }\n ],\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n }\n ],\n \"name\": \"On-Call Schedule Updated\",\n \"tags\": [\n \"tag1\",\n \"tag2\",\n \"tag3\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"layers\": [\n {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"seconds\": 300\n },\n \"members\": [\n {\n \"user\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\"\n }\n }\n ],\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n }\n ],\n \"name\": \"On-Call Schedule Updated\",\n \"tags\": [\n \"tag1\",\n \"tag2\",\n \"tag3\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"layers\": [\n {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"seconds\": 300\n },\n \"members\": [\n {\n \"user\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\"\n }\n }\n ],\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n }\n ],\n \"name\": \"On-Call Schedule Updated\",\n \"tags\": [\n \"tag1\",\n \"tag2\",\n \"tag3\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"layers\": [\n {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"seconds\": 300\n },\n \"members\": [\n {\n \"user\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\"\n }\n }\n ],\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n }\n ],\n \"name\": \"On-Call Schedule Updated\",\n \"tags\": [\n \"tag1\",\n \"tag2\",\n \"tag3\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"layers\": [\n {\n \"effective_date\": \"2025-02-03T05:00:00Z\",\n \"end_date\": \"2025-12-31T00:00:00Z\",\n \"interval\": {\n \"seconds\": 300\n },\n \"members\": [\n {\n \"user\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\"\n }\n }\n ],\n \"name\": \"Layer 1\",\n \"restrictions\": [\n {\n \"end_day\": \"friday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"rotation_start\": \"2025-02-01T00:00:00Z\"\n }\n ],\n \"name\": \"On-Call Schedule Updated\",\n \"tags\": [\n \"tag1\",\n \"tag2\",\n \"tag3\"\n ],\n \"time_zone\": \"America/New_York\"\n },\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"schedules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create on-call escalation policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": true,\n \"retries\": 2,\n \"steps\": [\n {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600,\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n },\n {\n \"id\": \"00000000-aba3-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n },\n {\n \"assignment\": \"round-robin\",\n \"escalate_after_seconds\": 3600,\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-abb1-0000-0000-000000000000\",\n \"type\": \"users\"\n }\n ]\n }\n ]\n },\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
]
},
"description": "Create a new on-call escalation policy"
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": true,\n \"retries\": 2,\n \"steps\": [\n {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600,\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n },\n {\n \"id\": \"00000000-aba3-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n },\n {\n \"assignment\": \"round-robin\",\n \"escalate_after_seconds\": 3600,\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-abb1-0000-0000-000000000000\",\n \"type\": \"users\"\n }\n ]\n }\n ]\n },\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": true,\n \"retries\": 2\n },\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"relationships\": {\n \"steps\": {\n \"data\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"steps\"\n }\n ]\n },\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"avatar\": \"\",\n \"description\": \"Team 1 description\",\n \"handle\": \"team1\",\n \"name\": \"Team 1\"\n },\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n },\n {\n \"attributes\": {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600\n },\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"relationships\": {\n \"targets\": {\n \"data\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n },\n {\n \"id\": \"00000000-aba3-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"steps\"\n },\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n },\n {\n \"id\": \"00000000-aba3-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": true,\n \"retries\": 2,\n \"steps\": [\n {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600,\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n },\n {\n \"id\": \"00000000-aba3-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n },\n {\n \"assignment\": \"round-robin\",\n \"escalate_after_seconds\": 3600,\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-abb1-0000-0000-000000000000\",\n \"type\": \"users\"\n }\n ]\n }\n ]\n },\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": true,\n \"retries\": 2,\n \"steps\": [\n {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600,\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n },\n {\n \"id\": \"00000000-aba3-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n },\n {\n \"assignment\": \"round-robin\",\n \"escalate_after_seconds\": 3600,\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-abb1-0000-0000-000000000000\",\n \"type\": \"users\"\n }\n ]\n }\n ]\n },\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": true,\n \"retries\": 2,\n \"steps\": [\n {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600,\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n },\n {\n \"id\": \"00000000-aba3-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n },\n {\n \"assignment\": \"round-robin\",\n \"escalate_after_seconds\": 3600,\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-abb1-0000-0000-000000000000\",\n \"type\": \"users\"\n }\n ]\n }\n ]\n },\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": true,\n \"retries\": 2,\n \"steps\": [\n {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600,\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n },\n {\n \"id\": \"00000000-aba3-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n },\n {\n \"assignment\": \"round-robin\",\n \"escalate_after_seconds\": 3600,\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-abb1-0000-0000-000000000000\",\n \"type\": \"users\"\n }\n ]\n }\n ]\n },\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get on-call escalation policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
],
"variable": [
{
"key": "policy_id",
"value": "a3000000-0000-0000-0000-000000000000"
}
]
},
"description": "Get an on-call escalation policy"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": true,\n \"retries\": 2\n },\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"relationships\": {\n \"steps\": {\n \"data\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"steps\"\n }\n ]\n },\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"avatar\": \"\",\n \"description\": \"Team 1 description\",\n \"handle\": \"team1\",\n \"name\": \"Team 1\"\n },\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n },\n {\n \"attributes\": {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600\n },\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"relationships\": {\n \"targets\": {\n \"data\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n },\n {\n \"id\": \"00000000-aba3-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"steps\"\n },\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n },\n {\n \"id\": \"00000000-aba3-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update on-call escalation policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": false,\n \"retries\": 2,\n \"steps\": [\n {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600,\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n }\n ]\n }\n ]\n },\n \"id\": \"a3000000-0000-0000-0000-000000000000\",\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
],
"variable": [
{
"key": "policy_id",
"value": "a3000000-0000-0000-0000-000000000000"
}
]
},
"description": "Update an on-call escalation policy"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": false,\n \"retries\": 2,\n \"steps\": [\n {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600,\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n }\n ]\n }\n ]\n },\n \"id\": \"a3000000-0000-0000-0000-000000000000\",\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": true,\n \"retries\": 2\n },\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"relationships\": {\n \"steps\": {\n \"data\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"steps\"\n }\n ]\n },\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"avatar\": \"\",\n \"description\": \"Team 1 description\",\n \"handle\": \"team1\",\n \"name\": \"Team 1\"\n },\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n },\n {\n \"attributes\": {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600\n },\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"relationships\": {\n \"targets\": {\n \"data\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n },\n {\n \"id\": \"00000000-aba3-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"steps\"\n },\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n },\n {\n \"id\": \"00000000-aba3-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": false,\n \"retries\": 2,\n \"steps\": [\n {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600,\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n }\n ]\n }\n ]\n },\n \"id\": \"a3000000-0000-0000-0000-000000000000\",\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": false,\n \"retries\": 2,\n \"steps\": [\n {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600,\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n }\n ]\n }\n ]\n },\n \"id\": \"a3000000-0000-0000-0000-000000000000\",\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": false,\n \"retries\": 2,\n \"steps\": [\n {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600,\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n }\n ]\n }\n ]\n },\n \"id\": \"a3000000-0000-0000-0000-000000000000\",\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": false,\n \"retries\": 2,\n \"steps\": [\n {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600,\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n }\n ]\n }\n ]\n },\n \"id\": \"a3000000-0000-0000-0000-000000000000\",\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Escalation Policy 1 description\",\n \"name\": \"Escalation Policy 1\",\n \"resolve_page_on_policy_end\": false,\n \"retries\": 2,\n \"steps\": [\n {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600,\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"targets\": [\n {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n },\n {\n \"id\": \"00000000-aba2-0000-0000-000000000000\",\n \"type\": \"schedules\"\n }\n ]\n }\n ]\n },\n \"id\": \"a3000000-0000-0000-0000-000000000000\",\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"00000000-da3a-0000-0000-000000000000\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete on-call escalation policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"variable": [
{
"key": "policy_id",
"value": "a3000000-0000-0000-0000-000000000000"
}
]
},
"description": "Delete an on-call escalation policy"
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/escalation-policies/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"escalation-policies",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get on-call team routing rules",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/teams/:team_id/routing-rules?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"teams",
":team_id",
"routing-rules"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `rules`, `rules.policy`."
}
],
"variable": [
{
"key": "team_id",
"value": "27590dae-47be-4a7d-9abf-8f4e45124020"
}
]
},
"description": "Get a team's on-call routing rules"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/teams/:team_id/routing-rules?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"teams",
":team_id",
"routing-rules"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `rules`, `rules.policy`."
}
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"27590dae-47be-4a7d-9abf-8f4e45124020\",\n \"relationships\": {\n \"rules\": {\n \"data\": [\n {\n \"id\": \"03aff2d6-6cbf-496c-997f-a857bbe9a94a\",\n \"type\": \"team_routing_rules\"\n },\n {\n \"id\": \"03aff2d6-6cbf-496c-997f-a857bbe9a94a\",\n \"type\": \"team_routing_rules\"\n }\n ]\n }\n },\n \"type\": \"team_routing_rules\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"actions\": null,\n \"query\": \"tags.service:test\",\n \"time_restriction\": {\n \"restrictions\": [\n {\n \"end_day\": \"monday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n },\n {\n \"end_day\": \"tuesday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"tuesday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"time_zone\": \"\"\n },\n \"urgency\": \"high\"\n },\n \"id\": \"03aff2d6-6cbf-496c-997f-a857bbe9a94a\",\n \"relationships\": {\n \"policy\": {\n \"data\": null\n }\n },\n \"type\": \"team_routing_rules\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/teams/:team_id/routing-rules?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"teams",
":team_id",
"routing-rules"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `rules`, `rules.policy`."
}
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Set on-call team routing rules",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"rules\": [\n {\n \"actions\": null,\n \"policy_id\": \"\",\n \"query\": \"tags.service:test\",\n \"time_restriction\": {\n \"restrictions\": [\n {\n \"end_day\": \"monday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n },\n {\n \"end_day\": \"tuesday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"tuesday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"time_zone\": \"\"\n },\n \"urgency\": \"high\"\n },\n {\n \"actions\": [\n {\n \"channel\": \"channel\",\n \"type\": \"send_slack_message\",\n \"workspace\": \"workspace\"\n }\n ],\n \"policy_id\": \"fad4eee1-13f5-40d8-886b-4e56d8d5d1c6\",\n \"query\": \"\",\n \"time_restriction\": null,\n \"urgency\": \"low\"\n }\n ]\n },\n \"id\": \"27590dae-47be-4a7d-9abf-8f4e45124020\",\n \"type\": \"team_routing_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/teams/:team_id/routing-rules?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"teams",
":team_id",
"routing-rules"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `rules`, `rules.policy`."
}
],
"variable": [
{
"key": "team_id",
"value": "27590dae-47be-4a7d-9abf-8f4e45124020"
}
]
},
"description": "Set a team's on-call routing rules"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"rules\": [\n {\n \"actions\": null,\n \"policy_id\": \"\",\n \"query\": \"tags.service:test\",\n \"time_restriction\": {\n \"restrictions\": [\n {\n \"end_day\": \"monday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n },\n {\n \"end_day\": \"tuesday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"tuesday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"time_zone\": \"\"\n },\n \"urgency\": \"high\"\n },\n {\n \"actions\": [\n {\n \"channel\": \"channel\",\n \"type\": \"send_slack_message\",\n \"workspace\": \"workspace\"\n }\n ],\n \"policy_id\": \"fad4eee1-13f5-40d8-886b-4e56d8d5d1c6\",\n \"query\": \"\",\n \"time_restriction\": null,\n \"urgency\": \"low\"\n }\n ]\n },\n \"id\": \"27590dae-47be-4a7d-9abf-8f4e45124020\",\n \"type\": \"team_routing_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/teams/:team_id/routing-rules?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"teams",
":team_id",
"routing-rules"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `rules`, `rules.policy`."
}
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"27590dae-47be-4a7d-9abf-8f4e45124020\",\n \"relationships\": {\n \"rules\": {\n \"data\": [\n {\n \"id\": \"03aff2d6-6cbf-496c-997f-a857bbe9a94a\",\n \"type\": \"team_routing_rules\"\n },\n {\n \"id\": \"03aff2d6-6cbf-496c-997f-a857bbe9a94a\",\n \"type\": \"team_routing_rules\"\n }\n ]\n }\n },\n \"type\": \"team_routing_rules\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"actions\": null,\n \"query\": \"tags.service:test\",\n \"time_restriction\": {\n \"restrictions\": [\n {\n \"end_day\": \"monday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n },\n {\n \"end_day\": \"tuesday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"tuesday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"time_zone\": \"\"\n },\n \"urgency\": \"high\"\n },\n \"id\": \"03aff2d6-6cbf-496c-997f-a857bbe9a94a\",\n \"relationships\": {\n \"policy\": {\n \"data\": null\n }\n },\n \"type\": \"team_routing_rules\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"rules\": [\n {\n \"actions\": null,\n \"policy_id\": \"\",\n \"query\": \"tags.service:test\",\n \"time_restriction\": {\n \"restrictions\": [\n {\n \"end_day\": \"monday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"monday\",\n \"start_time\": \"09:00:00\"\n },\n {\n \"end_day\": \"tuesday\",\n \"end_time\": \"17:00:00\",\n \"start_day\": \"tuesday\",\n \"start_time\": \"09:00:00\"\n }\n ],\n \"time_zone\": \"\"\n },\n \"urgency\": \"high\"\n },\n {\n \"actions\": [\n {\n \"channel\": \"channel\",\n \"type\": \"send_slack_message\",\n \"workspace\": \"workspace\"\n }\n ],\n \"policy_id\": \"fad4eee1-13f5-40d8-886b-4e56d8d5d1c6\",\n \"query\": \"\",\n \"time_restriction\": null,\n \"urgency\": \"low\"\n }\n ]\n },\n \"id\": \"27590dae-47be-4a7d-9abf-8f4e45124020\",\n \"type\": \"team_routing_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/teams/:team_id/routing-rules?include=officia ipsum dolo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"teams",
":team_id",
"routing-rules"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `rules`, `rules.policy`."
}
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get the schedule on-call user",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id/on-call?include=officia ipsum dolo&filter[at_ts]=2025-05-07T02:53:01Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id",
"on-call"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Specifies related resources to include in the response as a comma-separated list. Allowed value: `user`."
},
{
"key": "filter[at_ts]",
"value": "2025-05-07T02:53:01Z",
"description": "Retrieves the on-call user at the given timestamp (ISO-8601). Defaults to the current time if omitted.\""
}
],
"variable": [
{
"key": "schedule_id",
"value": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
}
]
},
"description": "Retrieves the user who is on-call for the specified schedule at a given time."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id/on-call?include=officia ipsum dolo&filter[at_ts]=2025-05-07T02:53:01Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id",
"on-call"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Specifies related resources to include in the response as a comma-separated list. Allowed value: `user`."
},
{
"key": "filter[at_ts]",
"value": "2025-05-07T02:53:01Z",
"description": "Retrieves the on-call user at the given timestamp (ISO-8601). Defaults to the current time if omitted.\""
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"end\": \"2025-05-07T03:53:01.206662873Z\",\n \"start\": \"2025-05-07T02:53:01.206662814Z\"\n },\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"shifts\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"email\": \"foo@bar.com\",\n \"name\": \"User 1\",\n \"status\": \"\"\n },\n \"id\": \"00000000-aba1-0000-0000-000000000000\",\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id/on-call?include=officia ipsum dolo&filter[at_ts]=2025-05-07T02:53:01Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id",
"on-call"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Specifies related resources to include in the response as a comma-separated list. Allowed value: `user`."
},
{
"key": "filter[at_ts]",
"value": "2025-05-07T02:53:01Z",
"description": "Retrieves the on-call user at the given timestamp (ISO-8601). Defaults to the current time if omitted.\""
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id/on-call?include=officia ipsum dolo&filter[at_ts]=2025-05-07T02:53:01Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id",
"on-call"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Specifies related resources to include in the response as a comma-separated list. Allowed value: `user`."
},
{
"key": "filter[at_ts]",
"value": "2025-05-07T02:53:01Z",
"description": "Retrieves the on-call user at the given timestamp (ISO-8601). Defaults to the current time if omitted.\""
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id/on-call?include=officia ipsum dolo&filter[at_ts]=2025-05-07T02:53:01Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id",
"on-call"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Specifies related resources to include in the response as a comma-separated list. Allowed value: `user`."
},
{
"key": "filter[at_ts]",
"value": "2025-05-07T02:53:01Z",
"description": "Retrieves the on-call user at the given timestamp (ISO-8601). Defaults to the current time if omitted.\""
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id/on-call?include=officia ipsum dolo&filter[at_ts]=2025-05-07T02:53:01Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id",
"on-call"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Specifies related resources to include in the response as a comma-separated list. Allowed value: `user`."
},
{
"key": "filter[at_ts]",
"value": "2025-05-07T02:53:01Z",
"description": "Retrieves the on-call user at the given timestamp (ISO-8601). Defaults to the current time if omitted.\""
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/schedules/:schedule_id/on-call?include=officia ipsum dolo&filter[at_ts]=2025-05-07T02:53:01Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"schedules",
":schedule_id",
"on-call"
],
"query": [
{
"key": "include",
"value": "officia ipsum dolo",
"description": "Specifies related resources to include in the response as a comma-separated list. Allowed value: `user`."
},
{
"key": "filter[at_ts]",
"value": "2025-05-07T02:53:01Z",
"description": "Retrieves the on-call user at the given timestamp (ISO-8601). Defaults to the current time if omitted.\""
}
],
"variable": [
{
"key": "schedule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get team on-call users",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/teams/:team_id/on-call?include=esse commodo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"teams",
":team_id",
"on-call"
],
"query": [
{
"key": "include",
"value": "esse commodo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `responders`, `escalations`, `escalations.responders`."
}
],
"variable": [
{
"key": "team_id",
"value": "27590dae-47be-4a7d-9abf-8f4e45124020"
}
]
},
"description": "Get a team's on-call users at a given time"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/teams/:team_id/on-call?include=esse commodo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"teams",
":team_id",
"on-call"
],
"query": [
{
"key": "include",
"value": "esse commodo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `responders`, `escalations`, `escalations.responders`."
}
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"111ee23r-aaaaa-aaaa-aaww-1234wertsd23\",\n \"relationships\": {\n \"escalations\": {\n \"data\": [\n {\n \"id\": \"111ee23r-aaaaa-aaaa-aaww-1234wertsd23\",\n \"type\": \"escalation_policy_steps\"\n }\n ]\n },\n \"responders\": {\n \"data\": [\n {\n \"id\": \"111ee23r-aaaaa-aaaa-aaww-1234wertsd23\",\n \"type\": \"users\"\n }\n ]\n }\n },\n \"type\": \"team_oncall_responders\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"email\": \"test@test.com\",\n \"name\": \"Test User\",\n \"status\": \"active\"\n },\n \"id\": \"111ee23r-aaaaa-aaaa-aaww-1234wertsd23\",\n \"type\": \"users\"\n },\n {\n \"id\": \"111ee23r-aaaaa-aaaa-aaww-1234wertsd23\",\n \"relationships\": {\n \"responders\": {\n \"data\": [\n {\n \"id\": \"111ee23r-aaaaa-aaaa-aaww-1234wertsd23\",\n \"type\": \"users\"\n }\n ]\n }\n },\n \"type\": \"escalation_policy_steps\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/teams/:team_id/on-call?include=esse commodo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"teams",
":team_id",
"on-call"
],
"query": [
{
"key": "include",
"value": "esse commodo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `responders`, `escalations`, `escalations.responders`."
}
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/teams/:team_id/on-call?include=esse commodo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"teams",
":team_id",
"on-call"
],
"query": [
{
"key": "include",
"value": "esse commodo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `responders`, `escalations`, `escalations.responders`."
}
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/teams/:team_id/on-call?include=esse commodo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"teams",
":team_id",
"on-call"
],
"query": [
{
"key": "include",
"value": "esse commodo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `responders`, `escalations`, `escalations.responders`."
}
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/teams/:team_id/on-call?include=esse commodo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"teams",
":team_id",
"on-call"
],
"query": [
{
"key": "include",
"value": "esse commodo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `responders`, `escalations`, `escalations.responders`."
}
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/on-call/teams/:team_id/on-call?include=esse commodo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"on-call",
"teams",
":team_id",
"on-call"
],
"query": [
{
"key": "include",
"value": "esse commodo",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `responders`, `escalations`, `escalations.responders`."
}
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Configure your [Datadog On-Call](https://docs.datadoghq.com/service_management/on-call/)\ndirectly through the Datadog API.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Opsgenie Integration",
"item": [
{
"name": "Get all service objects",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services"
]
},
"description": "Get a list of all services from the Datadog Opsgenie integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": null,\n \"name\": \"fake-opsgenie-service-name\",\n \"region\": \"us\"\n }\n },\n {\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": null,\n \"name\": \"fake-opsgenie-service-name\",\n \"region\": \"us\"\n }\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a new service object",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"name\": \"fake-opsgenie-service-name\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n \"region\": \"us\",\n \"custom_url\": \"https://example.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services"
]
},
"description": "Create a new service object in the Opsgenie integration."
},
"response": [
{
"name": "CREATED",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"name\": \"fake-opsgenie-service-name\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n \"region\": \"us\",\n \"custom_url\": \"https://example.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": null,\n \"name\": \"fake-opsgenie-service-name\",\n \"region\": \"us\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"name\": \"fake-opsgenie-service-name\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n \"region\": \"us\",\n \"custom_url\": \"https://example.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"name\": \"fake-opsgenie-service-name\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n \"region\": \"us\",\n \"custom_url\": \"https://example.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"name\": \"fake-opsgenie-service-name\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n \"region\": \"us\",\n \"custom_url\": \"https://example.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"name\": \"fake-opsgenie-service-name\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n \"region\": \"us\",\n \"custom_url\": \"https://example.com\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a single service object",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id",
"value": "pariatur consequat"
}
]
},
"description": "Get a single service from the Datadog Opsgenie integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": null,\n \"name\": \"fake-opsgenie-service-name\",\n \"region\": \"us\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a single service object",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": \"https://example.com\",\n \"name\": \"fake-opsgenie-service-name\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n \"region\": \"us\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id",
"value": "pariatur consequat"
}
]
},
"description": "Update a single service object in the Datadog Opsgenie integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": \"https://example.com\",\n \"name\": \"fake-opsgenie-service-name\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n \"region\": \"us\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": null,\n \"name\": \"fake-opsgenie-service-name\",\n \"region\": \"us\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": \"https://example.com\",\n \"name\": \"fake-opsgenie-service-name\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n \"region\": \"us\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": \"https://example.com\",\n \"name\": \"fake-opsgenie-service-name\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n \"region\": \"us\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": \"https://example.com\",\n \"name\": \"fake-opsgenie-service-name\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n \"region\": \"us\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": \"https://example.com\",\n \"name\": \"fake-opsgenie-service-name\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n \"region\": \"us\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"596da4af-0563-4097-90ff-07230c3f9db3\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": \"https://example.com\",\n \"name\": \"fake-opsgenie-service-name\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n \"region\": \"us\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a single service object",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete a single service object in the Datadog Opsgenie integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)\ndirectly through the Datadog API.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Organizations",
"item": [
{
"name": "Create a child organization",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New child org\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/org",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org"
]
},
"description": "Create a child organization.\n\nThis endpoint requires the\n[multi-organization account](https://docs.datadoghq.com/account_management/multi_organization/)\nfeature and must be enabled by\n[contacting support](https://docs.datadoghq.com/help/).\n\nOnce a new child organization is created, you can interact with it\nby using the `org.public_id`, `api_key.key`, and\n`application_key.hash` provided in the response."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New child org\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/org",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"api_key\": {\n \"created\": \"2019-08-02 15:31:07\",\n \"created_by\": \"john@example.com\",\n \"key\": \"1234512345123456abcabc912349abcd\",\n \"name\": \"example user\"\n },\n \"application_key\": {\n \"hash\": \"1234512345123459cda4eb9ced49a3d84fd0138c\",\n \"name\": \"example user\",\n \"owner\": \"example.com\"\n },\n \"org\": {\n \"created\": \"2019-09-26T17:28:28Z\",\n \"description\": \"some description\",\n \"name\": \"New child org\",\n \"public_id\": \"abcdef12345\",\n \"settings\": {\n \"private_widget_share\": false,\n \"saml\": {\n \"enabled\": false\n },\n \"saml_autocreate_access_role\": \"ro\",\n \"saml_autocreate_users_domains\": {\n \"domains\": [\n \"example.com\",\n \"example.com\"\n ],\n \"enabled\": false\n },\n \"saml_can_be_enabled\": false,\n \"saml_idp_endpoint\": \"https://my.saml.endpoint\",\n \"saml_idp_initiated_login\": {\n \"enabled\": false\n },\n \"saml_idp_metadata_uploaded\": false,\n \"saml_login_url\": \"https://my.saml.login.url\",\n \"saml_strict_mode\": {\n \"enabled\": false\n }\n },\n \"trial\": false\n },\n \"user\": {\n \"access_role\": \"ro\",\n \"disabled\": false,\n \"email\": \"test@datadoghq.com\",\n \"handle\": \"test@datadoghq.com\",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"name\": \"test user\",\n \"verified\": true\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New child org\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/org",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New child org\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/org",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New child org\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/org",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List your managed organizations",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/org",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org"
]
},
"description": "This endpoint returns data on your top-level organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/org",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"orgs\": [\n {\n \"created\": \"2019-09-26T17:28:28Z\",\n \"description\": \"some description\",\n \"name\": \"New child org\",\n \"public_id\": \"abcdef12345\",\n \"settings\": {\n \"private_widget_share\": false,\n \"saml\": {\n \"enabled\": false\n },\n \"saml_autocreate_access_role\": \"ro\",\n \"saml_autocreate_users_domains\": {\n \"domains\": [\n \"example.com\",\n \"example.com\"\n ],\n \"enabled\": false\n },\n \"saml_can_be_enabled\": false,\n \"saml_idp_endpoint\": \"https://my.saml.endpoint\",\n \"saml_idp_initiated_login\": {\n \"enabled\": false\n },\n \"saml_idp_metadata_uploaded\": false,\n \"saml_login_url\": \"https://my.saml.login.url\",\n \"saml_strict_mode\": {\n \"enabled\": false\n }\n },\n \"trial\": false\n },\n {\n \"created\": \"2019-09-26T17:28:28Z\",\n \"description\": \"some description\",\n \"name\": \"New child org\",\n \"public_id\": \"abcdef12345\",\n \"settings\": {\n \"private_widget_share\": false,\n \"saml\": {\n \"enabled\": false\n },\n \"saml_autocreate_access_role\": \"ro\",\n \"saml_autocreate_users_domains\": {\n \"domains\": [\n \"example.com\",\n \"example.com\"\n ],\n \"enabled\": false\n },\n \"saml_can_be_enabled\": false,\n \"saml_idp_endpoint\": \"https://my.saml.endpoint\",\n \"saml_idp_initiated_login\": {\n \"enabled\": false\n },\n \"saml_idp_metadata_uploaded\": false,\n \"saml_login_url\": \"https://my.saml.login.url\",\n \"saml_strict_mode\": {\n \"enabled\": false\n }\n },\n \"trial\": false\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/org",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/org",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get organization information",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/org/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org",
":public_id"
],
"variable": [
{
"key": "public_id",
"value": "abc123"
}
]
},
"description": "Get organization information."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/org/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"org\": {\n \"created\": \"2019-09-26T17:28:28Z\",\n \"description\": \"some description\",\n \"name\": \"New child org\",\n \"public_id\": \"abcdef12345\",\n \"settings\": {\n \"private_widget_share\": false,\n \"saml\": {\n \"enabled\": false\n },\n \"saml_autocreate_access_role\": \"ro\",\n \"saml_autocreate_users_domains\": {\n \"domains\": [\n \"example.com\",\n \"example.com\"\n ],\n \"enabled\": false\n },\n \"saml_can_be_enabled\": false,\n \"saml_idp_endpoint\": \"https://my.saml.endpoint\",\n \"saml_idp_initiated_login\": {\n \"enabled\": false\n },\n \"saml_idp_metadata_uploaded\": false,\n \"saml_login_url\": \"https://my.saml.login.url\",\n \"saml_strict_mode\": {\n \"enabled\": false\n }\n },\n \"trial\": false\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/org/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/org/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/org/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update your organization",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created\": \"2019-09-26T17:28:28Z\",\n \"description\": \"some description\",\n \"name\": \"New child org\",\n \"public_id\": \"abcdef12345\",\n \"settings\": {\n \"private_widget_share\": false,\n \"saml\": {\n \"enabled\": false\n },\n \"saml_autocreate_access_role\": \"ro\",\n \"saml_autocreate_users_domains\": {\n \"domains\": [\n \"example.com\",\n \"example.com\"\n ],\n \"enabled\": false\n },\n \"saml_can_be_enabled\": false,\n \"saml_idp_endpoint\": \"https://my.saml.endpoint\",\n \"saml_idp_initiated_login\": {\n \"enabled\": false\n },\n \"saml_idp_metadata_uploaded\": false,\n \"saml_login_url\": \"https://my.saml.login.url\",\n \"saml_strict_mode\": {\n \"enabled\": false\n }\n },\n \"trial\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/org/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org",
":public_id"
],
"variable": [
{
"key": "public_id",
"value": "abc123"
}
]
},
"description": "Update your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created\": \"2019-09-26T17:28:28Z\",\n \"description\": \"some description\",\n \"name\": \"New child org\",\n \"public_id\": \"abcdef12345\",\n \"settings\": {\n \"private_widget_share\": false,\n \"saml\": {\n \"enabled\": false\n },\n \"saml_autocreate_access_role\": \"ro\",\n \"saml_autocreate_users_domains\": {\n \"domains\": [\n \"example.com\",\n \"example.com\"\n ],\n \"enabled\": false\n },\n \"saml_can_be_enabled\": false,\n \"saml_idp_endpoint\": \"https://my.saml.endpoint\",\n \"saml_idp_initiated_login\": {\n \"enabled\": false\n },\n \"saml_idp_metadata_uploaded\": false,\n \"saml_login_url\": \"https://my.saml.login.url\",\n \"saml_strict_mode\": {\n \"enabled\": false\n }\n },\n \"trial\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/org/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"org\": {\n \"created\": \"2019-09-26T17:28:28Z\",\n \"description\": \"some description\",\n \"name\": \"New child org\",\n \"public_id\": \"abcdef12345\",\n \"settings\": {\n \"private_widget_share\": false,\n \"saml\": {\n \"enabled\": false\n },\n \"saml_autocreate_access_role\": \"ro\",\n \"saml_autocreate_users_domains\": {\n \"domains\": [\n \"example.com\",\n \"example.com\"\n ],\n \"enabled\": false\n },\n \"saml_can_be_enabled\": false,\n \"saml_idp_endpoint\": \"https://my.saml.endpoint\",\n \"saml_idp_initiated_login\": {\n \"enabled\": false\n },\n \"saml_idp_metadata_uploaded\": false,\n \"saml_login_url\": \"https://my.saml.login.url\",\n \"saml_strict_mode\": {\n \"enabled\": false\n }\n },\n \"trial\": false\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created\": \"2019-09-26T17:28:28Z\",\n \"description\": \"some description\",\n \"name\": \"New child org\",\n \"public_id\": \"abcdef12345\",\n \"settings\": {\n \"private_widget_share\": false,\n \"saml\": {\n \"enabled\": false\n },\n \"saml_autocreate_access_role\": \"ro\",\n \"saml_autocreate_users_domains\": {\n \"domains\": [\n \"example.com\",\n \"example.com\"\n ],\n \"enabled\": false\n },\n \"saml_can_be_enabled\": false,\n \"saml_idp_endpoint\": \"https://my.saml.endpoint\",\n \"saml_idp_initiated_login\": {\n \"enabled\": false\n },\n \"saml_idp_metadata_uploaded\": false,\n \"saml_login_url\": \"https://my.saml.login.url\",\n \"saml_strict_mode\": {\n \"enabled\": false\n }\n },\n \"trial\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/org/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created\": \"2019-09-26T17:28:28Z\",\n \"description\": \"some description\",\n \"name\": \"New child org\",\n \"public_id\": \"abcdef12345\",\n \"settings\": {\n \"private_widget_share\": false,\n \"saml\": {\n \"enabled\": false\n },\n \"saml_autocreate_access_role\": \"ro\",\n \"saml_autocreate_users_domains\": {\n \"domains\": [\n \"example.com\",\n \"example.com\"\n ],\n \"enabled\": false\n },\n \"saml_can_be_enabled\": false,\n \"saml_idp_endpoint\": \"https://my.saml.endpoint\",\n \"saml_idp_initiated_login\": {\n \"enabled\": false\n },\n \"saml_idp_metadata_uploaded\": false,\n \"saml_login_url\": \"https://my.saml.login.url\",\n \"saml_strict_mode\": {\n \"enabled\": false\n }\n },\n \"trial\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/org/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created\": \"2019-09-26T17:28:28Z\",\n \"description\": \"some description\",\n \"name\": \"New child org\",\n \"public_id\": \"abcdef12345\",\n \"settings\": {\n \"private_widget_share\": false,\n \"saml\": {\n \"enabled\": false\n },\n \"saml_autocreate_access_role\": \"ro\",\n \"saml_autocreate_users_domains\": {\n \"domains\": [\n \"example.com\",\n \"example.com\"\n ],\n \"enabled\": false\n },\n \"saml_can_be_enabled\": false,\n \"saml_idp_endpoint\": \"https://my.saml.endpoint\",\n \"saml_idp_initiated_login\": {\n \"enabled\": false\n },\n \"saml_idp_metadata_uploaded\": false,\n \"saml_login_url\": \"https://my.saml.login.url\",\n \"saml_strict_mode\": {\n \"enabled\": false\n }\n },\n \"trial\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/org/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Upload IdP metadata",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "idp_file",
"value": "laborum commodo voluptate velit",
"description": "The IdP metadata XML file",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/api/v2/saml_configurations/idp_metadata",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"saml_configurations",
"idp_metadata"
]
},
"description": "Endpoint for uploading IdP metadata for SAML setup.\n\nUse this endpoint to upload or replace IdP metadata for SAML login configuration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "idp_file",
"value": "laborum commodo voluptate velit",
"description": "The IdP metadata XML file",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/api/v2/saml_configurations/idp_metadata",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"saml_configurations",
"idp_metadata"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "idp_file",
"value": "laborum commodo voluptate velit",
"description": "The IdP metadata XML file",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/api/v2/saml_configurations/idp_metadata",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"saml_configurations",
"idp_metadata"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "idp_file",
"value": "laborum commodo voluptate velit",
"description": "The IdP metadata XML file",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/api/v2/saml_configurations/idp_metadata",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"saml_configurations",
"idp_metadata"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "idp_file",
"value": "laborum commodo voluptate velit",
"description": "The IdP metadata XML file",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/api/v2/saml_configurations/idp_metadata",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"saml_configurations",
"idp_metadata"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Spin-off Child Organization",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/org/:public_id/downgrade",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org",
":public_id",
"downgrade"
],
"variable": [
{
"key": "public_id",
"value": "abc123"
}
]
},
"description": "Only available for MSP customers. Removes a child organization from the hierarchy of the master organization and places the child organization on a 30-day trial."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/org/:public_id/downgrade",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org",
":public_id",
"downgrade"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"message\": \"cupidatat tempor\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/org/:public_id/downgrade",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org",
":public_id",
"downgrade"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/org/:public_id/downgrade",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org",
":public_id",
"downgrade"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/org/:public_id/downgrade",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org",
":public_id",
"downgrade"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List Org Configs",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs"
]
},
"description": "Returns all Org Configs (name, description, and value)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": \"abcd1234\",\n \"type\": \"org_configs\",\n \"attributes\": {\n \"name\": \"monitor_timezone\",\n \"description\": \"Frobulate the turbo encabulator manifold\",\n \"value_type\": \"bool\",\n \"value\": {\n \"description\": \"The value of an Org Config.\"\n },\n \"modified_at\": \"1969-10-15T16:54:17.892Z\"\n }\n },\n {\n \"id\": \"abcd1234\",\n \"type\": \"org_configs\",\n \"attributes\": {\n \"name\": \"monitor_timezone\",\n \"description\": \"Frobulate the turbo encabulator manifold\",\n \"value_type\": \"bool\",\n \"value\": {\n \"description\": \"The value of an Org Config.\"\n },\n \"modified_at\": \"1954-05-05T07:24:55.770Z\"\n }\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a specific Org Config value",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs/:org_config_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs",
":org_config_name"
],
"variable": [
{
"key": "org_config_name",
"value": "monitor_timezone"
}
]
},
"description": "Return the name, description, and value of a specific Org Config."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs/:org_config_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs",
":org_config_name"
],
"variable": [
{
"key": "org_config_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"abcd1234\",\n \"type\": \"org_configs\",\n \"attributes\": {\n \"name\": \"monitor_timezone\",\n \"description\": \"Frobulate the turbo encabulator manifold\",\n \"value_type\": \"bool\",\n \"value\": {\n \"description\": \"The value of an Org Config.\"\n },\n \"modified_at\": \"2020-09-27T03:18:05.664Z\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs/:org_config_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs",
":org_config_name"
],
"variable": [
{
"key": "org_config_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs/:org_config_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs",
":org_config_name"
],
"variable": [
{
"key": "org_config_name"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs/:org_config_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs",
":org_config_name"
],
"variable": [
{
"key": "org_config_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs/:org_config_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs",
":org_config_name"
],
"variable": [
{
"key": "org_config_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs/:org_config_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs",
":org_config_name"
],
"variable": [
{
"key": "org_config_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a specific Org Config",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"org_configs\",\n \"attributes\": {\n \"value\": {\n \"description\": \"The value of an Org Config.\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs/:org_config_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs",
":org_config_name"
],
"variable": [
{
"key": "org_config_name",
"value": "monitor_timezone"
}
]
},
"description": "Update the value of a specific Org Config."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"org_configs\",\n \"attributes\": {\n \"value\": {\n \"description\": \"The value of an Org Config.\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs/:org_config_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs",
":org_config_name"
],
"variable": [
{
"key": "org_config_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"abcd1234\",\n \"type\": \"org_configs\",\n \"attributes\": {\n \"name\": \"monitor_timezone\",\n \"description\": \"Frobulate the turbo encabulator manifold\",\n \"value_type\": \"bool\",\n \"value\": {\n \"description\": \"The value of an Org Config.\"\n },\n \"modified_at\": \"2020-09-27T03:18:05.664Z\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"org_configs\",\n \"attributes\": {\n \"value\": {\n \"description\": \"The value of an Org Config.\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs/:org_config_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs",
":org_config_name"
],
"variable": [
{
"key": "org_config_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"org_configs\",\n \"attributes\": {\n \"value\": {\n \"description\": \"The value of an Org Config.\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs/:org_config_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs",
":org_config_name"
],
"variable": [
{
"key": "org_config_name"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"org_configs\",\n \"attributes\": {\n \"value\": {\n \"description\": \"The value of an Org Config.\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs/:org_config_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs",
":org_config_name"
],
"variable": [
{
"key": "org_config_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"org_configs\",\n \"attributes\": {\n \"value\": {\n \"description\": \"The value of an Org Config.\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs/:org_config_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs",
":org_config_name"
],
"variable": [
{
"key": "org_config_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"org_configs\",\n \"attributes\": {\n \"value\": {\n \"description\": \"The value of an Org Config.\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/org_configs/:org_config_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"org_configs",
":org_config_name"
],
"variable": [
{
"key": "org_config_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Create, edit, and manage your organizations. Read more about [multi-org accounts](https://docs.datadoghq.com/account_management/multi_organization).",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "PagerDuty Integration",
"item": [
{
"name": "Create a new service object",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"service_name\": \"\",\n \"service_key\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services"
]
},
"description": "Create a new service object in the PagerDuty integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"service_name\": \"\",\n \"service_key\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"service_name\": \"\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"service_name\": \"\",\n \"service_key\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"service_name\": \"\",\n \"service_key\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"service_name\": \"\",\n \"service_key\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a single service object",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name",
"value": "pariatur"
}
]
},
"description": "Get service name in the Datadog-PagerDuty integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"service_name\": \"\"\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a single service object",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"service_key\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name",
"value": "pariatur"
}
]
},
"description": "Update a single service object in the Datadog-PagerDuty integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"service_key\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"service_key\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"service_key\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"service_key\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"service_key\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a single service object",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name",
"value": "pariatur"
}
]
},
"description": "Delete a single service object in the Datadog-PagerDuty integration."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Authentication error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/pagerduty/configuration/services/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"pagerduty",
"configuration",
"services",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Configure your [Datadog-PagerDuty integration](https://docs.datadoghq.com/integrations/pagerduty/)\ndirectly through the Datadog API.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Powerpack",
"item": [
{
"name": "Get all powerpacks",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks"
],
"query": [
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of powerpacks in the response.",
"disabled": true
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page.",
"disabled": true
}
]
},
"description": "Get a list of all powerpacks."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks"
],
"query": [
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of powerpacks in the response.",
"disabled": true
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"content\": \"example\",\n \"type\": \"note\"\n },\n \"layout\": {\n \"height\": 5,\n \"width\": 10,\n \"x\": 0,\n \"y\": 0\n }\n }\n ],\n \"layout_type\": \"ordered\",\n \"type\": \"group\",\n \"show_title\": true,\n \"title\": \"Sample Powerpack\"\n },\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"live_span\": \"5m\"\n },\n \"name\": \"Sample Powerpack\",\n \"description\": \"Powerpack for ABC\",\n \"tags\": [\n \"tag:foo1\"\n ],\n \"template_variables\": [\n {\n \"defaults\": [\n \"*\"\n ],\n \"name\": \"test\"\n }\n ]\n },\n \"id\": \"labore elit qui Lorem\",\n \"relationships\": {\n \"author\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"powerpack\"\n },\n {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"content\": \"example\",\n \"type\": \"note\"\n },\n \"layout\": {\n \"height\": 5,\n \"width\": 10,\n \"x\": 0,\n \"y\": 0\n }\n }\n ],\n \"layout_type\": \"ordered\",\n \"type\": \"group\",\n \"show_title\": true,\n \"title\": \"Sample Powerpack\"\n },\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"live_span\": \"5m\"\n },\n \"name\": \"Sample Powerpack\",\n \"description\": \"Powerpack for ABC\",\n \"tags\": [\n \"tag:foo1\"\n ],\n \"template_variables\": [\n {\n \"defaults\": [\n \"*\"\n ],\n \"name\": \"test\"\n }\n ]\n },\n \"id\": \"id dolore mollit nostrud\",\n \"relationships\": {\n \"author\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"powerpack\"\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1945-08-04T17:17:02.460Z\",\n \"disabled\": true,\n \"email\": \"sint cillum labore et nisi\",\n \"handle\": \"dolore qui sit\",\n \"icon\": \"sed\",\n \"modified_at\": \"1963-02-04T22:26:01.153Z\",\n \"name\": \"incididunt aliqua exercitation nulla\",\n \"service_account\": true,\n \"status\": \"fugiat aliquip\",\n \"title\": \"sunt Lorem in in\",\n \"verified\": true\n },\n \"id\": \"ut occaecat elit ea Ut\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2006-04-21T08:44:06.628Z\",\n \"disabled\": false,\n \"email\": \"adipisicing ad in esse\",\n \"handle\": \"magna esse eiusmod consectetur\",\n \"icon\": \"proident elit\",\n \"modified_at\": \"1957-07-31T13:28:48.899Z\",\n \"name\": \"in\",\n \"service_account\": true,\n \"status\": \"eu anim quis velit ad\",\n \"title\": \"Ut sint\",\n \"verified\": true\n },\n \"id\": \"dolor et nulla\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ],\n \"links\": {\n \"first\": \"ullamco Duis et nisi\",\n \"last\": \"https://app.datadoghq.com/api/v2/powerpacks?page[offset]=0&page[limit]=25\",\n \"next\": \"https://app.datadoghq.com/api/v2/powerpacks?page[offset]=25&page[limit]=25\",\n \"prev\": \"ad\",\n \"self\": \"https://app.datadoghq.com/api/v2/powerpacks\"\n },\n \"meta\": {\n \"pagination\": {\n \"first_offset\": 7318215,\n \"last_offset\": -64388293,\n \"limit\": 56192801,\n \"next_offset\": 35193708,\n \"offset\": 1861722,\n \"prev_offset\": 81475855,\n \"total\": 53267914,\n \"type\": \"veniam et officia occaecat dolore\"\n }\n }\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks"
],
"query": [
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of powerpacks in the response.",
"disabled": true
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a new powerpack",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"content\": \"example\",\n \"type\": \"note\"\n },\n \"layout\": {\n \"height\": 5,\n \"width\": 10,\n \"x\": 0,\n \"y\": 0\n }\n }\n ],\n \"layout_type\": \"ordered\",\n \"type\": \"group\",\n \"show_title\": true,\n \"title\": \"Sample Powerpack\"\n },\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"live_span\": \"5m\"\n },\n \"name\": \"Sample Powerpack\",\n \"description\": \"Powerpack for ABC\",\n \"tags\": [\n \"tag:foo1\"\n ],\n \"template_variables\": [\n {\n \"defaults\": [\n \"*\"\n ],\n \"name\": \"test\"\n }\n ]\n },\n \"id\": \"cillum\",\n \"relationships\": {\n \"author\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"powerpack\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks"
]
},
"description": "Create a powerpack."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"content\": \"example\",\n \"type\": \"note\"\n },\n \"layout\": {\n \"height\": 5,\n \"width\": 10,\n \"x\": 0,\n \"y\": 0\n }\n }\n ],\n \"layout_type\": \"ordered\",\n \"type\": \"group\",\n \"show_title\": true,\n \"title\": \"Sample Powerpack\"\n },\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"live_span\": \"5m\"\n },\n \"name\": \"Sample Powerpack\",\n \"description\": \"Powerpack for ABC\",\n \"tags\": [\n \"tag:foo1\"\n ],\n \"template_variables\": [\n {\n \"defaults\": [\n \"*\"\n ],\n \"name\": \"test\"\n }\n ]\n },\n \"id\": \"cillum\",\n \"relationships\": {\n \"author\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"powerpack\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"content\": \"example\",\n \"type\": \"note\"\n },\n \"layout\": {\n \"height\": 5,\n \"width\": 10,\n \"x\": 0,\n \"y\": 0\n }\n }\n ],\n \"layout_type\": \"ordered\",\n \"type\": \"group\",\n \"show_title\": true,\n \"title\": \"Sample Powerpack\"\n },\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"live_span\": \"5m\"\n },\n \"name\": \"Sample Powerpack\",\n \"description\": \"Powerpack for ABC\",\n \"tags\": [\n \"tag:foo1\"\n ],\n \"template_variables\": [\n {\n \"defaults\": [\n \"*\"\n ],\n \"name\": \"test\"\n }\n ]\n },\n \"id\": \"in conse\",\n \"relationships\": {\n \"author\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"powerpack\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"2008-08-22T13:04:00.288Z\",\n \"disabled\": false,\n \"email\": \"dolor anim\",\n \"handle\": \"ea culpa\",\n \"icon\": \"veniam Lorem\",\n \"modified_at\": \"1955-07-19T10:55:30.782Z\",\n \"name\": \"cupidatat officia fugiat\",\n \"service_account\": true,\n \"status\": \"nulla Duis\",\n \"title\": \"ipsum\",\n \"verified\": false\n },\n \"id\": \"enim consectetur dolore\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2002-08-21T05:57:54.208Z\",\n \"disabled\": true,\n \"email\": \"ullamco aliquip\",\n \"handle\": \"labore adipisicing sunt culpa\",\n \"icon\": \"do\",\n \"modified_at\": \"1962-12-03T20:37:58.554Z\",\n \"name\": \"in exercita\",\n \"service_account\": true,\n \"status\": \"voluptate anim\",\n \"title\": \"adipisicing\",\n \"verified\": false\n },\n \"id\": \"consectetur\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"content\": \"example\",\n \"type\": \"note\"\n },\n \"layout\": {\n \"height\": 5,\n \"width\": 10,\n \"x\": 0,\n \"y\": 0\n }\n }\n ],\n \"layout_type\": \"ordered\",\n \"type\": \"group\",\n \"show_title\": true,\n \"title\": \"Sample Powerpack\"\n },\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"live_span\": \"5m\"\n },\n \"name\": \"Sample Powerpack\",\n \"description\": \"Powerpack for ABC\",\n \"tags\": [\n \"tag:foo1\"\n ],\n \"template_variables\": [\n {\n \"defaults\": [\n \"*\"\n ],\n \"name\": \"test\"\n }\n ]\n },\n \"id\": \"cillum\",\n \"relationships\": {\n \"author\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"powerpack\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"content\": \"example\",\n \"type\": \"note\"\n },\n \"layout\": {\n \"height\": 5,\n \"width\": 10,\n \"x\": 0,\n \"y\": 0\n }\n }\n ],\n \"layout_type\": \"ordered\",\n \"type\": \"group\",\n \"show_title\": true,\n \"title\": \"Sample Powerpack\"\n },\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"live_span\": \"5m\"\n },\n \"name\": \"Sample Powerpack\",\n \"description\": \"Powerpack for ABC\",\n \"tags\": [\n \"tag:foo1\"\n ],\n \"template_variables\": [\n {\n \"defaults\": [\n \"*\"\n ],\n \"name\": \"test\"\n }\n ]\n },\n \"id\": \"cillum\",\n \"relationships\": {\n \"author\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"powerpack\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a powerpack",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete a powerpack."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Powerpack Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a Powerpack",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_id",
"value": "pariatur consequat"
}
]
},
"description": "Get a powerpack."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"content\": \"example\",\n \"type\": \"note\"\n },\n \"layout\": {\n \"height\": 5,\n \"width\": 10,\n \"x\": 0,\n \"y\": 0\n }\n }\n ],\n \"layout_type\": \"ordered\",\n \"type\": \"group\",\n \"show_title\": true,\n \"title\": \"Sample Powerpack\"\n },\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"live_span\": \"5m\"\n },\n \"name\": \"Sample Powerpack\",\n \"description\": \"Powerpack for ABC\",\n \"tags\": [\n \"tag:foo1\"\n ],\n \"template_variables\": [\n {\n \"defaults\": [\n \"*\"\n ],\n \"name\": \"test\"\n }\n ]\n },\n \"id\": \"in conse\",\n \"relationships\": {\n \"author\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"powerpack\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"2008-08-22T13:04:00.288Z\",\n \"disabled\": false,\n \"email\": \"dolor anim\",\n \"handle\": \"ea culpa\",\n \"icon\": \"veniam Lorem\",\n \"modified_at\": \"1955-07-19T10:55:30.782Z\",\n \"name\": \"cupidatat officia fugiat\",\n \"service_account\": true,\n \"status\": \"nulla Duis\",\n \"title\": \"ipsum\",\n \"verified\": false\n },\n \"id\": \"enim consectetur dolore\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2002-08-21T05:57:54.208Z\",\n \"disabled\": true,\n \"email\": \"ullamco aliquip\",\n \"handle\": \"labore adipisicing sunt culpa\",\n \"icon\": \"do\",\n \"modified_at\": \"1962-12-03T20:37:58.554Z\",\n \"name\": \"in exercita\",\n \"service_account\": true,\n \"status\": \"voluptate anim\",\n \"title\": \"adipisicing\",\n \"verified\": false\n },\n \"id\": \"consectetur\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Powerpack Not Found.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a powerpack",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"content\": \"example\",\n \"type\": \"note\"\n },\n \"layout\": {\n \"height\": 5,\n \"width\": 10,\n \"x\": 0,\n \"y\": 0\n }\n }\n ],\n \"layout_type\": \"ordered\",\n \"type\": \"group\",\n \"show_title\": true,\n \"title\": \"Sample Powerpack\"\n },\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"live_span\": \"5m\"\n },\n \"name\": \"Sample Powerpack\",\n \"description\": \"Powerpack for ABC\",\n \"tags\": [\n \"tag:foo1\"\n ],\n \"template_variables\": [\n {\n \"defaults\": [\n \"*\"\n ],\n \"name\": \"test\"\n }\n ]\n },\n \"id\": \"cillum\",\n \"relationships\": {\n \"author\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"powerpack\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_id",
"value": "pariatur consequat"
}
]
},
"description": "Update a powerpack."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"content\": \"example\",\n \"type\": \"note\"\n },\n \"layout\": {\n \"height\": 5,\n \"width\": 10,\n \"x\": 0,\n \"y\": 0\n }\n }\n ],\n \"layout_type\": \"ordered\",\n \"type\": \"group\",\n \"show_title\": true,\n \"title\": \"Sample Powerpack\"\n },\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"live_span\": \"5m\"\n },\n \"name\": \"Sample Powerpack\",\n \"description\": \"Powerpack for ABC\",\n \"tags\": [\n \"tag:foo1\"\n ],\n \"template_variables\": [\n {\n \"defaults\": [\n \"*\"\n ],\n \"name\": \"test\"\n }\n ]\n },\n \"id\": \"cillum\",\n \"relationships\": {\n \"author\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"powerpack\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"content\": \"example\",\n \"type\": \"note\"\n },\n \"layout\": {\n \"height\": 5,\n \"width\": 10,\n \"x\": 0,\n \"y\": 0\n }\n }\n ],\n \"layout_type\": \"ordered\",\n \"type\": \"group\",\n \"show_title\": true,\n \"title\": \"Sample Powerpack\"\n },\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"live_span\": \"5m\"\n },\n \"name\": \"Sample Powerpack\",\n \"description\": \"Powerpack for ABC\",\n \"tags\": [\n \"tag:foo1\"\n ],\n \"template_variables\": [\n {\n \"defaults\": [\n \"*\"\n ],\n \"name\": \"test\"\n }\n ]\n },\n \"id\": \"in conse\",\n \"relationships\": {\n \"author\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"powerpack\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"2008-08-22T13:04:00.288Z\",\n \"disabled\": false,\n \"email\": \"dolor anim\",\n \"handle\": \"ea culpa\",\n \"icon\": \"veniam Lorem\",\n \"modified_at\": \"1955-07-19T10:55:30.782Z\",\n \"name\": \"cupidatat officia fugiat\",\n \"service_account\": true,\n \"status\": \"nulla Duis\",\n \"title\": \"ipsum\",\n \"verified\": false\n },\n \"id\": \"enim consectetur dolore\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2002-08-21T05:57:54.208Z\",\n \"disabled\": true,\n \"email\": \"ullamco aliquip\",\n \"handle\": \"labore adipisicing sunt culpa\",\n \"icon\": \"do\",\n \"modified_at\": \"1962-12-03T20:37:58.554Z\",\n \"name\": \"in exercita\",\n \"service_account\": true,\n \"status\": \"voluptate anim\",\n \"title\": \"adipisicing\",\n \"verified\": false\n },\n \"id\": \"consectetur\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"content\": \"example\",\n \"type\": \"note\"\n },\n \"layout\": {\n \"height\": 5,\n \"width\": 10,\n \"x\": 0,\n \"y\": 0\n }\n }\n ],\n \"layout_type\": \"ordered\",\n \"type\": \"group\",\n \"show_title\": true,\n \"title\": \"Sample Powerpack\"\n },\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"live_span\": \"5m\"\n },\n \"name\": \"Sample Powerpack\",\n \"description\": \"Powerpack for ABC\",\n \"tags\": [\n \"tag:foo1\"\n ],\n \"template_variables\": [\n {\n \"defaults\": [\n \"*\"\n ],\n \"name\": \"test\"\n }\n ]\n },\n \"id\": \"cillum\",\n \"relationships\": {\n \"author\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"powerpack\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Powerpack Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"content\": \"example\",\n \"type\": \"note\"\n },\n \"layout\": {\n \"height\": 5,\n \"width\": 10,\n \"x\": 0,\n \"y\": 0\n }\n }\n ],\n \"layout_type\": \"ordered\",\n \"type\": \"group\",\n \"show_title\": true,\n \"title\": \"Sample Powerpack\"\n },\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"live_span\": \"5m\"\n },\n \"name\": \"Sample Powerpack\",\n \"description\": \"Powerpack for ABC\",\n \"tags\": [\n \"tag:foo1\"\n ],\n \"template_variables\": [\n {\n \"defaults\": [\n \"*\"\n ],\n \"name\": \"test\"\n }\n ]\n },\n \"id\": \"cillum\",\n \"relationships\": {\n \"author\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"powerpack\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"content\": \"example\",\n \"type\": \"note\"\n },\n \"layout\": {\n \"height\": 5,\n \"width\": 10,\n \"x\": 0,\n \"y\": 0\n }\n }\n ],\n \"layout_type\": \"ordered\",\n \"type\": \"group\",\n \"show_title\": true,\n \"title\": \"Sample Powerpack\"\n },\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"live_span\": \"5m\"\n },\n \"name\": \"Sample Powerpack\",\n \"description\": \"Powerpack for ABC\",\n \"tags\": [\n \"tag:foo1\"\n ],\n \"template_variables\": [\n {\n \"defaults\": [\n \"*\"\n ],\n \"name\": \"test\"\n }\n ]\n },\n \"id\": \"cillum\",\n \"relationships\": {\n \"author\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"powerpack\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "The Powerpack endpoints allow you to:\n\n- Get a Powerpack\n- Create a Powerpack\n- Delete a Powerpack\n- Get a list of all Powerpacks\n\nThe Patch and Delete API methods can only be performed on a Powerpack by\na user who has the powerpack create permission for that specific Powerpack.\n\nRead [Scale Graphing Expertise with Powerpacks](https://docs.datadoghq.com/dashboards/guide/powerpacks-best-practices/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Processes",
"item": [
{
"name": "Get all processes",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/processes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "pariatur consequat",
"description": "String to search processes by.",
"disabled": true
},
{
"key": "tags",
"value": "account:prod,user:admin",
"description": "Comma-separated list of tags to filter processes by.",
"disabled": true
},
{
"key": "from",
"value": "97337406",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.",
"disabled": true
},
{
"key": "to",
"value": "97337406",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.",
"disabled": true
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "pariatur consequat",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`.",
"disabled": true
}
]
},
"description": "Get all processes for your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/processes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "pariatur consequat",
"description": "String to search processes by.",
"disabled": true
},
{
"key": "tags",
"value": "account:prod,user:admin",
"description": "Comma-separated list of tags to filter processes by.",
"disabled": true
},
{
"key": "from",
"value": "97337406",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.",
"disabled": true
},
{
"key": "to",
"value": "97337406",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.",
"disabled": true
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "pariatur consequat",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"cmdline\": \"ut proident sint\",\n \"host\": \"adipisicing\",\n \"pid\": 78981866,\n \"ppid\": 50790226,\n \"start\": \"enim\",\n \"tags\": [\n \"eiusmod sunt tempor\",\n \"consequat esse\"\n ],\n \"timestamp\": \"reprehenderit sint Du\",\n \"user\": \"magna\"\n },\n \"id\": \"ullamco dolore magna\",\n \"type\": \"process\"\n },\n {\n \"attributes\": {\n \"cmdline\": \"dolore\",\n \"host\": \"tempor\",\n \"pid\": -98305511,\n \"ppid\": 61940497,\n \"start\": \"eu laborum eiusmod\",\n \"tags\": [\n \"eu sint ex\",\n \"quis in\"\n ],\n \"timestamp\": \"in velit irure incididunt\",\n \"user\": \"dolore pariatur\"\n },\n \"id\": \"reprehenderit proident\",\n \"type\": \"process\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"after\": \"911abf1204838d9cdfcb9a96d0b6a1bd03e1b514074f1ce1737c4cbd\",\n \"size\": 595\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/processes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "pariatur consequat",
"description": "String to search processes by.",
"disabled": true
},
{
"key": "tags",
"value": "account:prod,user:admin",
"description": "Comma-separated list of tags to filter processes by.",
"disabled": true
},
{
"key": "from",
"value": "97337406",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.",
"disabled": true
},
{
"key": "to",
"value": "97337406",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.",
"disabled": true
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "pariatur consequat",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/processes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "pariatur consequat",
"description": "String to search processes by.",
"disabled": true
},
{
"key": "tags",
"value": "account:prod,user:admin",
"description": "Comma-separated list of tags to filter processes by.",
"disabled": true
},
{
"key": "from",
"value": "97337406",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.",
"disabled": true
},
{
"key": "to",
"value": "97337406",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.",
"disabled": true
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "pariatur consequat",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/processes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "pariatur consequat",
"description": "String to search processes by.",
"disabled": true
},
{
"key": "tags",
"value": "account:prod,user:admin",
"description": "Comma-separated list of tags to filter processes by.",
"disabled": true
},
{
"key": "from",
"value": "97337406",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.",
"disabled": true
},
{
"key": "to",
"value": "97337406",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.",
"disabled": true
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "pariatur consequat",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "The processes API allows you to query processes data for your organization. See the [Live Processes page](https://docs.datadoghq.com/infrastructure/process/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Restriction Policies",
"item": [
{
"name": "Update a restriction policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"restriction_policy\",\n \"id\": \"dashboard:abc-def-ghi\",\n \"attributes\": {}\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/restriction_policy/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"restriction_policy",
":resource_id"
],
"variable": [
{
"key": "resource_id",
"value": "dashboard:abc-def-ghi"
}
]
},
"description": "Updates the restriction policy associated with a resource.\n\n#### Supported resources\nRestriction policies can be applied to the following resources:\n- Connections: `connection`\n- Dashboards: `dashboard`\n- Notebooks: `notebook`\n- Security Rules: `security-rule`\n- Service Level Objectives: `slo`\n\n#### Supported relations for resources\nResource Type | Supported Relations\n-------------------------|--------------------------\nConnections | `viewer`, `editor`, `resolver`\nDashboards | `viewer`, `editor`\nNotebooks | `viewer`, `editor`\nSecurity Rules | `viewer`, `editor`\nService Level Objectives | `viewer`, `editor`"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"restriction_policy\",\n \"id\": \"dashboard:abc-def-ghi\",\n \"attributes\": {}\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/restriction_policy/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"restriction_policy",
":resource_id"
],
"variable": [
{
"key": "resource_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"restriction_policy\",\n \"id\": \"dashboard:abc-def-ghi\",\n \"attributes\": {}\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"restriction_policy\",\n \"id\": \"dashboard:abc-def-ghi\",\n \"attributes\": {}\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/restriction_policy/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"restriction_policy",
":resource_id"
],
"variable": [
{
"key": "resource_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"restriction_policy\",\n \"id\": \"dashboard:abc-def-ghi\",\n \"attributes\": {}\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/restriction_policy/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"restriction_policy",
":resource_id"
],
"variable": [
{
"key": "resource_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"restriction_policy\",\n \"id\": \"dashboard:abc-def-ghi\",\n \"attributes\": {}\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/restriction_policy/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"restriction_policy",
":resource_id"
],
"variable": [
{
"key": "resource_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a restriction policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/restriction_policy/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"restriction_policy",
":resource_id"
],
"variable": [
{
"key": "resource_id",
"value": "dashboard:abc-def-ghi"
}
]
},
"description": "Retrieves the restriction policy associated with a specified resource."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/restriction_policy/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"restriction_policy",
":resource_id"
],
"variable": [
{
"key": "resource_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"restriction_policy\",\n \"id\": \"dashboard:abc-def-ghi\",\n \"attributes\": {}\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/restriction_policy/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"restriction_policy",
":resource_id"
],
"variable": [
{
"key": "resource_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/restriction_policy/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"restriction_policy",
":resource_id"
],
"variable": [
{
"key": "resource_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/restriction_policy/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"restriction_policy",
":resource_id"
],
"variable": [
{
"key": "resource_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a restriction policy",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/restriction_policy/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"restriction_policy",
":resource_id"
],
"variable": [
{
"key": "resource_id",
"value": "dashboard:abc-def-ghi"
}
]
},
"description": "Deletes the restriction policy associated with a specified resource."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/restriction_policy/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"restriction_policy",
":resource_id"
],
"variable": [
{
"key": "resource_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/restriction_policy/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"restriction_policy",
":resource_id"
],
"variable": [
{
"key": "resource_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/restriction_policy/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"restriction_policy",
":resource_id"
],
"variable": [
{
"key": "resource_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/restriction_policy/:resource_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"restriction_policy",
":resource_id"
],
"variable": [
{
"key": "resource_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "A restriction policy defines the access control rules for a resource, mapping a set of relations\n(such as editor and viewer) to a set of allowed principals (such as roles, teams, or users).\nThe restriction policy determines who is authorized to perform what actions on the resource.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Roles",
"item": [
{
"name": "List permissions",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"permissions"
]
},
"description": "Returns a list of all permissions, including name, description, and ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"permissions"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"type\": \"permissions\",\n \"attributes\": {\n \"created\": \"1972-03-11T01:22:33.040Z\",\n \"description\": \"officia quis qui Excepteur\",\n \"display_name\": \"anim sint velit aute et\",\n \"display_type\": \"aliquip voluptate eu in\",\n \"group_name\": \"dolor cillum labore ma\",\n \"name\": \"culpa veniam\",\n \"restricted\": true\n },\n \"id\": \"dolore occaecat laboris non\"\n },\n {\n \"type\": \"permissions\",\n \"attributes\": {\n \"created\": \"2020-04-07T16:00:13.055Z\",\n \"description\": \"Duis mollit occaecat\",\n \"display_name\": \"in dolor elit\",\n \"display_type\": \"sed \",\n \"group_name\": \"ut dolore Lorem\",\n \"name\": \"nulla\",\n \"restricted\": true\n },\n \"id\": \"commodo non labore\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"permissions"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"permissions"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"permissions"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List roles",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all roles by the given string.",
"disabled": true
},
{
"key": "filter[id]",
"value": "pariatur consequat",
"description": "Filter all roles by the given list of role IDs.",
"disabled": true
}
]
},
"description": "Returns all roles, including their names and their unique identifiers."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all roles by the given string.",
"disabled": true
},
{
"key": "filter[id]",
"value": "pariatur consequat",
"description": "Filter all roles by the given list of role IDs.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"type\": \"roles\",\n \"attributes\": {\n \"created_at\": \"1968-09-18T01:31:40.786Z\",\n \"modified_at\": \"1945-02-17T17:16:27.246Z\",\n \"name\": \"aliqua labore anim\",\n \"user_count\": 6399991\n },\n \"id\": \"dolor nulla\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"cillum quis\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"commodo est et mollit adipisicing\",\n \"type\": \"permissions\"\n }\n ]\n }\n }\n },\n {\n \"type\": \"roles\",\n \"attributes\": {\n \"created_at\": \"2023-08-22T23:11:33.485Z\",\n \"modified_at\": \"2017-08-19T12:50:37.782Z\",\n \"name\": \"aliqua enim amet nulla\",\n \"user_count\": -83939923\n },\n \"id\": \"consectetur non magna\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"amet nisi in\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"in consequat deserunt nisi\",\n \"type\": \"permissions\"\n }\n ]\n }\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": 78520069,\n \"total_filtered_count\": 88420530\n }\n }\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all roles by the given string.",
"disabled": true
},
{
"key": "filter[id]",
"value": "pariatur consequat",
"description": "Filter all roles by the given list of role IDs.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all roles by the given string.",
"disabled": true
},
{
"key": "filter[id]",
"value": "pariatur consequat",
"description": "Filter all roles by the given list of role IDs.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create role",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"developers\",\n \"created_at\": \"1994-02-12T16:59:27.016Z\",\n \"modified_at\": \"1983-03-19T17:56:16.965Z\"\n },\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"nisi consequat culpa ut\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"tempor\",\n \"type\": \"permissions\"\n }\n ]\n },\n \"users\": {\n \"data\": []\n }\n },\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
]
},
"description": "Create a new role for your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"developers\",\n \"created_at\": \"1994-02-12T16:59:27.016Z\",\n \"modified_at\": \"1983-03-19T17:56:16.965Z\"\n },\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"nisi consequat culpa ut\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"tempor\",\n \"type\": \"permissions\"\n }\n ]\n },\n \"users\": {\n \"data\": []\n }\n },\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"roles\",\n \"attributes\": {\n \"name\": \"developers\",\n \"created_at\": \"1952-03-16T03:35:41.140Z\",\n \"modified_at\": \"1947-10-06T20:12:51.643Z\"\n },\n \"id\": \"tempor nulla reprehenderit consequat Duis\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"ipsum dolore voluptate\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"incididunt sunt\",\n \"type\": \"permissions\"\n }\n ]\n }\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"developers\",\n \"created_at\": \"1994-02-12T16:59:27.016Z\",\n \"modified_at\": \"1983-03-19T17:56:16.965Z\"\n },\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"nisi consequat culpa ut\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"tempor\",\n \"type\": \"permissions\"\n }\n ]\n },\n \"users\": {\n \"data\": []\n }\n },\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"developers\",\n \"created_at\": \"1994-02-12T16:59:27.016Z\",\n \"modified_at\": \"1983-03-19T17:56:16.965Z\"\n },\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"nisi consequat culpa ut\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"tempor\",\n \"type\": \"permissions\"\n }\n ]\n },\n \"users\": {\n \"data\": []\n }\n },\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"developers\",\n \"created_at\": \"1994-02-12T16:59:27.016Z\",\n \"modified_at\": \"1983-03-19T17:56:16.965Z\"\n },\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"nisi consequat culpa ut\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"tempor\",\n \"type\": \"permissions\"\n }\n ]\n },\n \"users\": {\n \"data\": []\n }\n },\n \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a role",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id",
"value": "pariatur consequat"
}
]
},
"description": "Get a role in the organization specified by the role’s `role_id`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"roles\",\n \"attributes\": {\n \"created_at\": \"1970-01-14T09:57:50.131Z\",\n \"modified_at\": \"1945-05-16T00:07:56.329Z\",\n \"name\": \"nostrud veniam\",\n \"user_count\": 77202812\n },\n \"id\": \"aliquip ut pariatur ex\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"Duis ullamco ut reprehenderit culpa\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"dolor sit\",\n \"type\": \"permissions\"\n }\n ]\n }\n }\n }\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a role",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"1968-12-07T14:20:00.282Z\",\n \"modified_at\": \"2006-11-28T16:48:12.244Z\",\n \"name\": \"in\"\n },\n \"type\": \"roles\",\n \"id\": \"00000000-0000-1111-0000-000000000000\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"nisi adipisicing sed anim\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"sit magna\",\n \"type\": \"permissions\"\n }\n ]\n },\n \"users\": {\n \"data\": []\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id",
"value": "pariatur consequat"
}
]
},
"description": "Edit a role. Can only be used with application keys belonging to administrators."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"1968-12-07T14:20:00.282Z\",\n \"modified_at\": \"2006-11-28T16:48:12.244Z\",\n \"name\": \"in\"\n },\n \"type\": \"roles\",\n \"id\": \"00000000-0000-1111-0000-000000000000\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"nisi adipisicing sed anim\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"sit magna\",\n \"type\": \"permissions\"\n }\n ]\n },\n \"users\": {\n \"data\": []\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"roles\",\n \"attributes\": {\n \"created_at\": \"1979-01-17T07:00:05.940Z\",\n \"modified_at\": \"1958-11-03T02:21:34.716Z\",\n \"name\": \"Ut anim elit nisi\"\n },\n \"id\": \"occaecat\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"sed voluptate non labore\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"in fugiat laborum\",\n \"type\": \"permissions\"\n }\n ]\n }\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"1968-12-07T14:20:00.282Z\",\n \"modified_at\": \"2006-11-28T16:48:12.244Z\",\n \"name\": \"in\"\n },\n \"type\": \"roles\",\n \"id\": \"00000000-0000-1111-0000-000000000000\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"nisi adipisicing sed anim\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"sit magna\",\n \"type\": \"permissions\"\n }\n ]\n },\n \"users\": {\n \"data\": []\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"1968-12-07T14:20:00.282Z\",\n \"modified_at\": \"2006-11-28T16:48:12.244Z\",\n \"name\": \"in\"\n },\n \"type\": \"roles\",\n \"id\": \"00000000-0000-1111-0000-000000000000\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"nisi adipisicing sed anim\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"sit magna\",\n \"type\": \"permissions\"\n }\n ]\n },\n \"users\": {\n \"data\": []\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"1968-12-07T14:20:00.282Z\",\n \"modified_at\": \"2006-11-28T16:48:12.244Z\",\n \"name\": \"in\"\n },\n \"type\": \"roles\",\n \"id\": \"00000000-0000-1111-0000-000000000000\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"nisi adipisicing sed anim\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"sit magna\",\n \"type\": \"permissions\"\n }\n ]\n },\n \"users\": {\n \"data\": []\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unprocessable Entity",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"1968-12-07T14:20:00.282Z\",\n \"modified_at\": \"2006-11-28T16:48:12.244Z\",\n \"name\": \"in\"\n },\n \"type\": \"roles\",\n \"id\": \"00000000-0000-1111-0000-000000000000\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"nisi adipisicing sed anim\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"sit magna\",\n \"type\": \"permissions\"\n }\n ]\n },\n \"users\": {\n \"data\": []\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"1968-12-07T14:20:00.282Z\",\n \"modified_at\": \"2006-11-28T16:48:12.244Z\",\n \"name\": \"in\"\n },\n \"type\": \"roles\",\n \"id\": \"00000000-0000-1111-0000-000000000000\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"nisi adipisicing sed anim\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"sit magna\",\n \"type\": \"permissions\"\n }\n ]\n },\n \"users\": {\n \"data\": []\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete role",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id",
"value": "pariatur consequat"
}
]
},
"description": "Disables a role."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Authentication error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List permissions for a role",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id",
"value": "pariatur consequat"
}
]
},
"description": "Returns a list of all permissions for a single role."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"type\": \"permissions\",\n \"attributes\": {\n \"created\": \"1972-03-11T01:22:33.040Z\",\n \"description\": \"officia quis qui Excepteur\",\n \"display_name\": \"anim sint velit aute et\",\n \"display_type\": \"aliquip voluptate eu in\",\n \"group_name\": \"dolor cillum labore ma\",\n \"name\": \"culpa veniam\",\n \"restricted\": true\n },\n \"id\": \"dolore occaecat laboris non\"\n },\n {\n \"type\": \"permissions\",\n \"attributes\": {\n \"created\": \"2020-04-07T16:00:13.055Z\",\n \"description\": \"Duis mollit occaecat\",\n \"display_name\": \"in dolor elit\",\n \"display_type\": \"sed \",\n \"group_name\": \"ut dolore Lorem\",\n \"name\": \"nulla\",\n \"restricted\": true\n },\n \"id\": \"commodo non labore\"\n }\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Grant permission to a role",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"elit aliq\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id",
"value": "pariatur consequat"
}
]
},
"description": "Adds a permission to a role."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"elit aliq\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"type\": \"permissions\",\n \"attributes\": {\n \"created\": \"1972-03-11T01:22:33.040Z\",\n \"description\": \"officia quis qui Excepteur\",\n \"display_name\": \"anim sint velit aute et\",\n \"display_type\": \"aliquip voluptate eu in\",\n \"group_name\": \"dolor cillum labore ma\",\n \"name\": \"culpa veniam\",\n \"restricted\": true\n },\n \"id\": \"dolore occaecat laboris non\"\n },\n {\n \"type\": \"permissions\",\n \"attributes\": {\n \"created\": \"2020-04-07T16:00:13.055Z\",\n \"description\": \"Duis mollit occaecat\",\n \"display_name\": \"in dolor elit\",\n \"display_type\": \"sed \",\n \"group_name\": \"ut dolore Lorem\",\n \"name\": \"nulla\",\n \"restricted\": true\n },\n \"id\": \"commodo non labore\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"elit aliq\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"elit aliq\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"elit aliq\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"elit aliq\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Revoke permission",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"elit aliq\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id",
"value": "pariatur consequat"
}
]
},
"description": "Removes a permission from a role."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"elit aliq\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"type\": \"permissions\",\n \"attributes\": {\n \"created\": \"1972-03-11T01:22:33.040Z\",\n \"description\": \"officia quis qui Excepteur\",\n \"display_name\": \"anim sint velit aute et\",\n \"display_type\": \"aliquip voluptate eu in\",\n \"group_name\": \"dolor cillum labore ma\",\n \"name\": \"culpa veniam\",\n \"restricted\": true\n },\n \"id\": \"dolore occaecat laboris non\"\n },\n {\n \"type\": \"permissions\",\n \"attributes\": {\n \"created\": \"2020-04-07T16:00:13.055Z\",\n \"description\": \"Duis mollit occaecat\",\n \"display_name\": \"in dolor elit\",\n \"display_type\": \"sed \",\n \"group_name\": \"ut dolore Lorem\",\n \"name\": \"nulla\",\n \"restricted\": true\n },\n \"id\": \"commodo non labore\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"elit aliq\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"elit aliq\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"elit aliq\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"elit aliq\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all users of a role",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign,\nfor example `sort=-name`. Options: `name`, `email`, `status`.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all users by the given string. Defaults to no filtering.",
"disabled": true
}
],
"variable": [
{
"key": "role_id",
"value": "pariatur consequat"
}
]
},
"description": "Gets all users of a role."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign,\nfor example `sort=-name`. Options: `name`, `email`, `status`.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all users by the given string. Defaults to no filtering.",
"disabled": true
}
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"2016-06-21T01:04:16.799Z\",\n \"disabled\": true,\n \"email\": \"laborum labore nulla\",\n \"handle\": \"sed anim ipsum\",\n \"icon\": \"elit nisi dolore Excepteur ut\",\n \"modified_at\": \"1987-05-21T03:58:08.624Z\",\n \"name\": \"Lorem\",\n \"service_account\": false,\n \"status\": \"consequat Ut aliquip\",\n \"title\": \"aliqua tempor\",\n \"verified\": false\n },\n \"id\": \"adipisicing Duis\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2019-02-23T06:01:44.457Z\",\n \"disabled\": false,\n \"email\": \"sint eiusmod Ut consequat\",\n \"handle\": \"occaecat ullamco incididunt eu\",\n \"icon\": \"Ut dolor\",\n \"modified_at\": \"1946-04-15T11:31:03.027Z\",\n \"name\": \"non id\",\n \"service_account\": true,\n \"status\": \"Excepteur D\",\n \"title\": \"mollit in aute anim proident\",\n \"verified\": true\n },\n \"id\": \"ei\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ],\n \"included\": [\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"1957-02-12T18:48:25.171Z\",\n \"description\": \"consequat in commodo adipisicing\",\n \"disabled\": true,\n \"modified_at\": \"2005-01-30T19:04:56.267Z\",\n \"name\": \"consequat sit\",\n \"public_id\": \"tempor consequat proident\",\n \"sharing\": \"cillum proident incididunt\",\n \"url\": \"a\"\n },\n \"id\": \"eiusmod ut Lorem fugiat\"\n },\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"2015-10-18T08:46:20.466Z\",\n \"description\": \"in ut\",\n \"disabled\": true,\n \"modified_at\": \"1979-12-20T09:40:53.251Z\",\n \"name\": \"mollit irure ad ipsum\",\n \"public_id\": \"dolor id\",\n \"sharing\": \"elit nulla\",\n \"url\": \"nisi in\"\n },\n \"id\": \"deserunt amet\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": -17566972,\n \"total_filtered_count\": 91760735\n }\n }\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign,\nfor example `sort=-name`. Options: `name`, `email`, `status`.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all users by the given string. Defaults to no filtering.",
"disabled": true
}
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign,\nfor example `sort=-name`. Options: `name`, `email`, `status`.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all users by the given string. Defaults to no filtering.",
"disabled": true
}
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign,\nfor example `sort=-name`. Options: `name`, `email`, `status`.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all users by the given string. Defaults to no filtering.",
"disabled": true
}
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Add a user to a role",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_id",
"value": "pariatur consequat"
}
]
},
"description": "Adds a user to a role."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"2016-06-21T01:04:16.799Z\",\n \"disabled\": true,\n \"email\": \"laborum labore nulla\",\n \"handle\": \"sed anim ipsum\",\n \"icon\": \"elit nisi dolore Excepteur ut\",\n \"modified_at\": \"1987-05-21T03:58:08.624Z\",\n \"name\": \"Lorem\",\n \"service_account\": false,\n \"status\": \"consequat Ut aliquip\",\n \"title\": \"aliqua tempor\",\n \"verified\": false\n },\n \"id\": \"adipisicing Duis\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2019-02-23T06:01:44.457Z\",\n \"disabled\": false,\n \"email\": \"sint eiusmod Ut consequat\",\n \"handle\": \"occaecat ullamco incididunt eu\",\n \"icon\": \"Ut dolor\",\n \"modified_at\": \"1946-04-15T11:31:03.027Z\",\n \"name\": \"non id\",\n \"service_account\": true,\n \"status\": \"Excepteur D\",\n \"title\": \"mollit in aute anim proident\",\n \"verified\": true\n },\n \"id\": \"ei\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ],\n \"included\": [\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"1957-02-12T18:48:25.171Z\",\n \"description\": \"consequat in commodo adipisicing\",\n \"disabled\": true,\n \"modified_at\": \"2005-01-30T19:04:56.267Z\",\n \"name\": \"consequat sit\",\n \"public_id\": \"tempor consequat proident\",\n \"sharing\": \"cillum proident incididunt\",\n \"url\": \"a\"\n },\n \"id\": \"eiusmod ut Lorem fugiat\"\n },\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"2015-10-18T08:46:20.466Z\",\n \"description\": \"in ut\",\n \"disabled\": true,\n \"modified_at\": \"1979-12-20T09:40:53.251Z\",\n \"name\": \"mollit irure ad ipsum\",\n \"public_id\": \"dolor id\",\n \"sharing\": \"elit nulla\",\n \"url\": \"nisi in\"\n },\n \"id\": \"deserunt amet\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": -17566972,\n \"total_filtered_count\": 91760735\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Remove a user from a role",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_id",
"value": "pariatur consequat"
}
]
},
"description": "Removes a user from a role."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"2016-06-21T01:04:16.799Z\",\n \"disabled\": true,\n \"email\": \"laborum labore nulla\",\n \"handle\": \"sed anim ipsum\",\n \"icon\": \"elit nisi dolore Excepteur ut\",\n \"modified_at\": \"1987-05-21T03:58:08.624Z\",\n \"name\": \"Lorem\",\n \"service_account\": false,\n \"status\": \"consequat Ut aliquip\",\n \"title\": \"aliqua tempor\",\n \"verified\": false\n },\n \"id\": \"adipisicing Duis\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2019-02-23T06:01:44.457Z\",\n \"disabled\": false,\n \"email\": \"sint eiusmod Ut consequat\",\n \"handle\": \"occaecat ullamco incididunt eu\",\n \"icon\": \"Ut dolor\",\n \"modified_at\": \"1946-04-15T11:31:03.027Z\",\n \"name\": \"non id\",\n \"service_account\": true,\n \"status\": \"Excepteur D\",\n \"title\": \"mollit in aute anim proident\",\n \"verified\": true\n },\n \"id\": \"ei\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ],\n \"included\": [\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"1957-02-12T18:48:25.171Z\",\n \"description\": \"consequat in commodo adipisicing\",\n \"disabled\": true,\n \"modified_at\": \"2005-01-30T19:04:56.267Z\",\n \"name\": \"consequat sit\",\n \"public_id\": \"tempor consequat proident\",\n \"sharing\": \"cillum proident incididunt\",\n \"url\": \"a\"\n },\n \"id\": \"eiusmod ut Lorem fugiat\"\n },\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"2015-10-18T08:46:20.466Z\",\n \"description\": \"in ut\",\n \"disabled\": true,\n \"modified_at\": \"1979-12-20T09:40:53.251Z\",\n \"name\": \"mollit irure ad ipsum\",\n \"public_id\": \"dolor id\",\n \"sharing\": \"elit nulla\",\n \"url\": \"nisi in\"\n },\n \"id\": \"deserunt amet\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": -17566972,\n \"total_filtered_count\": 91760735\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a new role by cloning an existing role",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"roles\",\n \"attributes\": {\n \"name\": \"cloned-role\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/clone",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"clone"
],
"variable": [
{
"key": "role_id",
"value": "pariatur consequat"
}
]
},
"description": "Clone an existing role"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"roles\",\n \"attributes\": {\n \"name\": \"cloned-role\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/clone",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"clone"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"roles\",\n \"attributes\": {\n \"created_at\": \"1970-01-14T09:57:50.131Z\",\n \"modified_at\": \"1945-05-16T00:07:56.329Z\",\n \"name\": \"nostrud veniam\",\n \"user_count\": 77202812\n },\n \"id\": \"aliquip ut pariatur ex\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"Duis ullamco ut reprehenderit culpa\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"dolor sit\",\n \"type\": \"permissions\"\n }\n ]\n }\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"roles\",\n \"attributes\": {\n \"name\": \"cloned-role\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/clone",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"clone"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"roles\",\n \"attributes\": {\n \"name\": \"cloned-role\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/clone",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"clone"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"roles\",\n \"attributes\": {\n \"name\": \"cloned-role\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/clone",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"clone"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"roles\",\n \"attributes\": {\n \"name\": \"cloned-role\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/clone",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"clone"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"roles\",\n \"attributes\": {\n \"name\": \"cloned-role\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/clone",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"clone"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "The Roles API is used to create and manage Datadog roles, what\n[global permissions](https://docs.datadoghq.com/account_management/rbac/)\nthey grant, and which users belong to them.\n\nPermissions related to specific account assets can be granted to roles\nin the Datadog application without using this API. For example, granting\nread access on a specific log index to a role can be done in Datadog from the\n[Pipelines page](https://app.datadoghq.com/logs/pipelines).",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "RUM",
"item": [
{
"name": "Search RUM events",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@type:session AND @session.type:user\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": 20406456,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"events",
"search"
]
},
"description": "List endpoint returns RUM events that match a RUM search query.\n[Results are paginated][1].\n\nUse this endpoint to build complex RUM events filtering and search.\n\n[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@type:session AND @session.type:user\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": 20406456,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"events",
"search"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"service\": \"web-app\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"rum\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"service\": \"web-app\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"rum\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/rum/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@type:session AND @session.type:user\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": 20406456,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"events",
"search"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@type:session AND @session.type:user\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": 20406456,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"events",
"search"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@type:session AND @session.type:user\",\n \"to\": \"now\"\n },\n \"options\": {\n \"time_offset\": 20406456,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"events",
"search"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a list of RUM events",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@type:session @application_id:xxxx",
"description": "Search query following RUM syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
},
"description": "List endpoint returns events that match a RUM search query.\n[Results are paginated][1].\n\nUse this endpoint to see your latest RUM events.\n\n[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@type:session @application_id:xxxx",
"description": "Search query following RUM syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"service\": \"web-app\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"rum\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"service\": \"web-app\",\n \"tags\": [\n \"team:A\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"rum\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/rum/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@type:session @application_id:xxxx",
"description": "Search query following RUM syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@type:session @application_id:xxxx",
"description": "Search query following RUM syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@type:session @application_id:xxxx",
"description": "Search query following RUM syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested events.",
"disabled": true
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested events.",
"disabled": true
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of events in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of events in the response.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Aggregate RUM events",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@type:session AND @session.type:user\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"@view.time_spent\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"nulla aute Ut dolor\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n },\n {\n \"facet\": \"@view.time_spent\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"minim\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n }\n ],\n \"options\": {\n \"time_offset\": 44886083,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"analytics",
"aggregate"
]
},
"description": "The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@type:session AND @session.type:user\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"@view.time_spent\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"nulla aute Ut dolor\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n },\n {\n \"facet\": \"@view.time_spent\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"minim\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n }\n ],\n \"options\": {\n \"time_offset\": 44886083,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"analytics",
"aggregate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"buckets\": [\n {\n \"by\": {\n \"@session.type\": \"user\",\n \"@type\": \"view\"\n },\n \"computes\": {\n \"Duis_e\": \"ut reprehenderit et id occaecat\",\n \"minim27\": \"eiusmod sed\"\n }\n },\n {\n \"by\": {\n \"@session.type\": \"user\",\n \"@type\": \"view\"\n },\n \"computes\": {\n \"Duis_046\": \"consectetur sed id\",\n \"irure_a5\": \"reprehenderit laborum sit\",\n \"in_e2b\": \"consequat cillum\",\n \"commodo_f4c\": \"mollit\"\n }\n }\n ]\n },\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/rum/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@type:session AND @session.type:user\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"@view.time_spent\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"nulla aute Ut dolor\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n },\n {\n \"facet\": \"@view.time_spent\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"minim\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n }\n ],\n \"options\": {\n \"time_offset\": 44886083,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"analytics",
"aggregate"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@type:session AND @session.type:user\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"@view.time_spent\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"nulla aute Ut dolor\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n },\n {\n \"facet\": \"@view.time_spent\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"minim\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n }\n ],\n \"options\": {\n \"time_offset\": 44886083,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"analytics",
"aggregate"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"@type:session AND @session.type:user\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"@view.time_spent\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"nulla aute Ut dolor\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n },\n {\n \"facet\": \"@view.time_spent\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"minim\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n }\n ],\n \"options\": {\n \"time_offset\": 44886083,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"analytics",
"aggregate"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a RUM application",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abcd1234-0000-0000-abcd-1234abcd5678\",\n \"type\": \"rum_application_update\",\n \"attributes\": {\n \"name\": \"updated_name_for_my_existing_rum_application\",\n \"type\": \"browser\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":id"
],
"variable": [
{
"key": "id",
"value": "pariatur consequat"
}
]
},
"description": "Update the RUM application with given ID in your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abcd1234-0000-0000-abcd-1234abcd5678\",\n \"type\": \"rum_application_update\",\n \"attributes\": {\n \"name\": \"updated_name_for_my_existing_rum_application\",\n \"type\": \"browser\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"application_id\": \"abcd1234-0000-0000-abcd-1234abcd5678\",\n \"client_token\": \"abcd1234efgh5678ijkl90abcd1234efgh0\",\n \"created_at\": 1659479836169,\n \"created_by_handle\": \"john.doe\",\n \"name\": \"my_rum_application\",\n \"org_id\": 999,\n \"type\": \"browser\",\n \"updated_at\": 1659479836169,\n \"updated_by_handle\": \"jane.doe\",\n \"hash\": \"dolor enim non\",\n \"is_active\": true\n },\n \"id\": \"abcd1234-0000-0000-abcd-1234abcd5678\",\n \"type\": \"rum_application\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abcd1234-0000-0000-abcd-1234abcd5678\",\n \"type\": \"rum_application_update\",\n \"attributes\": {\n \"name\": \"updated_name_for_my_existing_rum_application\",\n \"type\": \"browser\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abcd1234-0000-0000-abcd-1234abcd5678\",\n \"type\": \"rum_application_update\",\n \"attributes\": {\n \"name\": \"updated_name_for_my_existing_rum_application\",\n \"type\": \"browser\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unprocessable Entity.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abcd1234-0000-0000-abcd-1234abcd5678\",\n \"type\": \"rum_application_update\",\n \"attributes\": {\n \"name\": \"updated_name_for_my_existing_rum_application\",\n \"type\": \"browser\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"abcd1234-0000-0000-abcd-1234abcd5678\",\n \"type\": \"rum_application_update\",\n \"attributes\": {\n \"name\": \"updated_name_for_my_existing_rum_application\",\n \"type\": \"browser\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a RUM application",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":id"
],
"variable": [
{
"key": "id",
"value": "pariatur consequat"
}
]
},
"description": "Get the RUM application with given ID in your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"application_id\": \"abcd1234-0000-0000-abcd-1234abcd5678\",\n \"client_token\": \"abcd1234efgh5678ijkl90abcd1234efgh0\",\n \"created_at\": 1659479836169,\n \"created_by_handle\": \"john.doe\",\n \"name\": \"my_rum_application\",\n \"org_id\": 999,\n \"type\": \"browser\",\n \"updated_at\": 1659479836169,\n \"updated_by_handle\": \"jane.doe\",\n \"hash\": \"dolor enim non\",\n \"is_active\": true\n },\n \"id\": \"abcd1234-0000-0000-abcd-1234abcd5678\",\n \"type\": \"rum_application\"\n }\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a RUM application",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":id"
],
"variable": [
{
"key": "id",
"value": "pariatur consequat"
}
]
},
"description": "Delete an existing RUM application in your organization."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a new RUM application",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_new_rum_application\",\n \"type\": \"browser\"\n },\n \"type\": \"rum_application_create\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications"
]
},
"description": "Create a new RUM application in your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_new_rum_application\",\n \"type\": \"browser\"\n },\n \"type\": \"rum_application_create\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"application_id\": \"abcd1234-0000-0000-abcd-1234abcd5678\",\n \"client_token\": \"abcd1234efgh5678ijkl90abcd1234efgh0\",\n \"created_at\": 1659479836169,\n \"created_by_handle\": \"john.doe\",\n \"name\": \"my_rum_application\",\n \"org_id\": 999,\n \"type\": \"browser\",\n \"updated_at\": 1659479836169,\n \"updated_by_handle\": \"jane.doe\",\n \"hash\": \"dolor enim non\",\n \"is_active\": true\n },\n \"id\": \"abcd1234-0000-0000-abcd-1234abcd5678\",\n \"type\": \"rum_application\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_new_rum_application\",\n \"type\": \"browser\"\n },\n \"type\": \"rum_application_create\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"my_new_rum_application\",\n \"type\": \"browser\"\n },\n \"type\": \"rum_application_create\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List all the RUM applications",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications"
]
},
"description": "List all the RUM applications in your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"application_id\": \"abcd1234-0000-0000-abcd-1234abcd5678\",\n \"created_at\": 1659479836169,\n \"created_by_handle\": \"john.doe\",\n \"name\": \"my_rum_application\",\n \"org_id\": 999,\n \"type\": \"browser\",\n \"updated_at\": 1659479836169,\n \"updated_by_handle\": \"jane.doe\",\n \"hash\": \"id\",\n \"is_active\": true\n },\n \"type\": \"rum_application\",\n \"id\": \"abcd1234-0000-0000-abcd-1234abcd5678\"\n },\n {\n \"attributes\": {\n \"application_id\": \"abcd1234-0000-0000-abcd-1234abcd5678\",\n \"created_at\": 1659479836169,\n \"created_by_handle\": \"john.doe\",\n \"name\": \"my_rum_application\",\n \"org_id\": 999,\n \"type\": \"browser\",\n \"updated_at\": 1659479836169,\n \"updated_by_handle\": \"jane.doe\",\n \"hash\": \"est ipsum Duis non irure\",\n \"is_active\": true\n },\n \"type\": \"rum_application\",\n \"id\": \"abcd1234-0000-0000-abcd-1234abcd5678\"\n }\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Manage your Real User Monitoring (RUM) applications, and search or aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/real_user_monitoring/) for more information",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "RUM Metrics",
"item": [
{
"name": "Get all rum-based metrics",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics"
]
},
"description": "Get the list of configured rum-based metrics with their definitions."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"event_type\": \"session\",\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ],\n \"uniqueness\": {\n \"when\": \"match\"\n }\n },\n \"id\": \"rum.sessions.webui.count\",\n \"type\": \"rum_metrics\"\n },\n {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"event_type\": \"session\",\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ],\n \"uniqueness\": {\n \"when\": \"match\"\n }\n },\n \"id\": \"rum.sessions.webui.count\",\n \"type\": \"rum_metrics\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a rum-based metric",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"rum.sessions.webui.count\",\n \"type\": \"rum_metrics\",\n \"attributes\": {\n \"event_type\": \"session\",\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@service:web-ui: \"\n },\n \"group_by\": [\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n },\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n }\n ],\n \"uniqueness\": {\n \"when\": \"match\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics"
]
},
"description": "Create a metric based on your organization's RUM data.\nReturns the rum-based metric object from the request body when the request is successful."
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"rum.sessions.webui.count\",\n \"type\": \"rum_metrics\",\n \"attributes\": {\n \"event_type\": \"session\",\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@service:web-ui: \"\n },\n \"group_by\": [\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n },\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n }\n ],\n \"uniqueness\": {\n \"when\": \"match\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"event_type\": \"session\",\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ],\n \"uniqueness\": {\n \"when\": \"match\"\n }\n },\n \"id\": \"rum.sessions.webui.count\",\n \"type\": \"rum_metrics\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"rum.sessions.webui.count\",\n \"type\": \"rum_metrics\",\n \"attributes\": {\n \"event_type\": \"session\",\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@service:web-ui: \"\n },\n \"group_by\": [\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n },\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n }\n ],\n \"uniqueness\": {\n \"when\": \"match\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"rum.sessions.webui.count\",\n \"type\": \"rum_metrics\",\n \"attributes\": {\n \"event_type\": \"session\",\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@service:web-ui: \"\n },\n \"group_by\": [\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n },\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n }\n ],\n \"uniqueness\": {\n \"when\": \"match\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"rum.sessions.webui.count\",\n \"type\": \"rum_metrics\",\n \"attributes\": {\n \"event_type\": \"session\",\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@service:web-ui: \"\n },\n \"group_by\": [\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n },\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n }\n ],\n \"uniqueness\": {\n \"when\": \"match\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"rum.sessions.webui.count\",\n \"type\": \"rum_metrics\",\n \"attributes\": {\n \"event_type\": \"session\",\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@service:web-ui: \"\n },\n \"group_by\": [\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n },\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n }\n ],\n \"uniqueness\": {\n \"when\": \"match\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a rum-based metric",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id",
"value": "tempor ipsum enim ea"
}
]
},
"description": "Get a specific rum-based metric from your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"event_type\": \"session\",\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ],\n \"uniqueness\": {\n \"when\": \"match\"\n }\n },\n \"id\": \"rum.sessions.webui.count\",\n \"type\": \"rum_metrics\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a rum-based metric",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"rum_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": true\n },\n \"filter\": {\n \"query\": \"@service:web-ui: \"\n },\n \"group_by\": [\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n },\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n }\n ]\n },\n \"id\": \"rum.sessions.webui.count\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id",
"value": "tempor ipsum enim ea"
}
]
},
"description": "Update a specific rum-based metric from your organization.\nReturns the rum-based metric object from the request body when the request is successful."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"rum_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": true\n },\n \"filter\": {\n \"query\": \"@service:web-ui: \"\n },\n \"group_by\": [\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n },\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n }\n ]\n },\n \"id\": \"rum.sessions.webui.count\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": true,\n \"path\": \"@duration\"\n },\n \"event_type\": \"session\",\n \"filter\": {\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\"\n },\n \"group_by\": [\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n },\n {\n \"path\": \"@http.status_code\",\n \"tag_name\": \"status_code\"\n }\n ],\n \"uniqueness\": {\n \"when\": \"match\"\n }\n },\n \"id\": \"rum.sessions.webui.count\",\n \"type\": \"rum_metrics\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"rum_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": true\n },\n \"filter\": {\n \"query\": \"@service:web-ui: \"\n },\n \"group_by\": [\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n },\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n }\n ]\n },\n \"id\": \"rum.sessions.webui.count\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"rum_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": true\n },\n \"filter\": {\n \"query\": \"@service:web-ui: \"\n },\n \"group_by\": [\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n },\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n }\n ]\n },\n \"id\": \"rum.sessions.webui.count\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"rum_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": true\n },\n \"filter\": {\n \"query\": \"@service:web-ui: \"\n },\n \"group_by\": [\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n },\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n }\n ]\n },\n \"id\": \"rum.sessions.webui.count\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"rum_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": true\n },\n \"filter\": {\n \"query\": \"@service:web-ui: \"\n },\n \"group_by\": [\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n },\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n }\n ]\n },\n \"id\": \"rum.sessions.webui.count\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"rum_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": true\n },\n \"filter\": {\n \"query\": \"@service:web-ui: \"\n },\n \"group_by\": [\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n },\n {\n \"path\": \"@browser.name\",\n \"tag_name\": \"browser_name\"\n }\n ]\n },\n \"id\": \"rum.sessions.webui.count\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a rum-based metric",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id",
"value": "tempor ipsum enim ea"
}
]
},
"description": "Delete a specific rum-based metric from your organization."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Manage configuration of [rum-based metrics](https://app.datadoghq.com/rum/generate-metrics) for your organization.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "RUM Retention Filters",
"item": [
{
"name": "Get all RUM retention filters",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters"
],
"variable": [
{
"key": "app_id",
"value": "proident dolor"
}
]
},
"description": "Get the list of RUM retention filters for a RUM application."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"enabled\": true,\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"query\": \"@session.has_replay:true\",\n \"sample_rate\": 25\n },\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n },\n {\n \"attributes\": {\n \"enabled\": true,\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"query\": \"@session.has_replay:true\",\n \"sample_rate\": 25\n },\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a RUM retention filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id",
"value": "proident dolor"
},
{
"key": "rf_id",
"value": "proident dolor"
}
]
},
"description": "Get a RUM retention filter for a RUM application."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id"
},
{
"key": "rf_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"query\": \"@session.has_replay:true\",\n \"sample_rate\": 25\n },\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id"
},
{
"key": "rf_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id"
},
{
"key": "rf_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id"
},
{
"key": "rf_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a RUM retention filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"retention_filters\",\n \"attributes\": {\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"sample_rate\": 25,\n \"enabled\": true,\n \"query\": \"@session.has_replay:true\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters"
],
"variable": [
{
"key": "app_id",
"value": "proident dolor"
}
]
},
"description": "Create a RUM retention filter for a RUM application.\nReturns RUM retention filter objects from the request body when the request is successful."
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"retention_filters\",\n \"attributes\": {\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"sample_rate\": 25,\n \"enabled\": true,\n \"query\": \"@session.has_replay:true\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"query\": \"@session.has_replay:true\",\n \"sample_rate\": 25\n },\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"retention_filters\",\n \"attributes\": {\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"sample_rate\": 25,\n \"enabled\": true,\n \"query\": \"@session.has_replay:true\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"retention_filters\",\n \"attributes\": {\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"sample_rate\": 25,\n \"enabled\": true,\n \"query\": \"@session.has_replay:true\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"retention_filters\",\n \"attributes\": {\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"sample_rate\": 25,\n \"enabled\": true,\n \"query\": \"@session.has_replay:true\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a RUM retention filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\",\n \"attributes\": {\n \"enabled\": true,\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"query\": \"@session.has_replay:true\",\n \"sample_rate\": 25\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id",
"value": "proident dolor"
},
{
"key": "rf_id",
"value": "proident dolor"
}
]
},
"description": "Update a RUM retention filter for a RUM application.\nReturns RUM retention filter objects from the request body when the request is successful."
},
"response": [
{
"name": "Updated",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\",\n \"attributes\": {\n \"enabled\": true,\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"query\": \"@session.has_replay:true\",\n \"sample_rate\": 25\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id"
},
{
"key": "rf_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"query\": \"@session.has_replay:true\",\n \"sample_rate\": 25\n },\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\",\n \"attributes\": {\n \"enabled\": true,\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"query\": \"@session.has_replay:true\",\n \"sample_rate\": 25\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id"
},
{
"key": "rf_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\",\n \"attributes\": {\n \"enabled\": true,\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"query\": \"@session.has_replay:true\",\n \"sample_rate\": 25\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id"
},
{
"key": "rf_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\",\n \"attributes\": {\n \"enabled\": true,\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"query\": \"@session.has_replay:true\",\n \"sample_rate\": 25\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id"
},
{
"key": "rf_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\",\n \"attributes\": {\n \"enabled\": true,\n \"event_type\": \"session\",\n \"name\": \"Retention filter for session\",\n \"query\": \"@session.has_replay:true\",\n \"sample_rate\": 25\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id"
},
{
"key": "rf_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a RUM retention filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id",
"value": "proident dolor"
},
{
"key": "rf_id",
"value": "proident dolor"
}
]
},
"description": "Delete a RUM retention filter for a RUM application."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id"
},
{
"key": "rf_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id"
},
{
"key": "rf_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id"
},
{
"key": "rf_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/retention_filters/:rf_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"retention_filters",
":rf_id"
],
"variable": [
{
"key": "app_id"
},
{
"key": "rf_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Order RUM retention filters",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n },\n {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/relationships/retention_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"relationships",
"retention_filters"
],
"variable": [
{
"key": "app_id",
"value": "proident dolor"
}
]
},
"description": "Order RUM retention filters for a RUM application.\nReturns RUM retention filter objects without attributes from the request body when the request is successful."
},
"response": [
{
"name": "Ordered",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n },\n {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/relationships/retention_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"relationships",
"retention_filters"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n },\n {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n },\n {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/relationships/retention_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"relationships",
"retention_filters"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n },\n {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/relationships/retention_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"relationships",
"retention_filters"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n },\n {\n \"id\": \"051601eb-54a0-abc0-03f9-cc02efa18892\",\n \"type\": \"retention_filters\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/applications/:app_id/relationships/retention_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"applications",
":app_id",
"relationships",
"retention_filters"
],
"variable": [
{
"key": "app_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Manage retention filters through [Manage Applications](https://app.datadoghq.com/rum/list) of RUM for your organization.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Security Monitoring",
"item": [
{
"name": "Create a suppression rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"name\": \"Custom suppression\",\n \"enabled\": true,\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"expiration_date\": 1703187336000,\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions"
]
},
"description": "Create a new suppression rule."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"name\": \"Custom suppression\",\n \"enabled\": true,\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"expiration_date\": 1703187336000,\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"creation_date\": 44860601,\n \"creator\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"editable\": true,\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"update_date\": -5607722,\n \"updater\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"version\": 42\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"suppressions\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"name\": \"Custom suppression\",\n \"enabled\": true,\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"expiration_date\": 1703187336000,\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"name\": \"Custom suppression\",\n \"enabled\": true,\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"expiration_date\": 1703187336000,\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"name\": \"Custom suppression\",\n \"enabled\": true,\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"expiration_date\": 1703187336000,\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"name\": \"Custom suppression\",\n \"enabled\": true,\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"expiration_date\": 1703187336000,\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a suppression rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Delete a specific suppression rule."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a suppression rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Get the details of a specific suppression rule."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"creation_date\": 44860601,\n \"creator\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"editable\": true,\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"update_date\": -5607722,\n \"updater\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"version\": 42\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"suppressions\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all suppression rules",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions"
]
},
"description": "Get the list of all suppression rules."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"creation_date\": -21123725,\n \"creator\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"editable\": true,\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"update_date\": -35750263,\n \"updater\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"version\": 42\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"suppressions\"\n },\n {\n \"attributes\": {\n \"creation_date\": -43845730,\n \"creator\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"editable\": true,\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"update_date\": 25149973,\n \"updater\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"version\": 42\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"suppressions\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get suppressions affecting a specific rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Get the list of suppressions that affect a specific existing rule by its ID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"creation_date\": -21123725,\n \"creator\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"editable\": true,\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"update_date\": -35750263,\n \"updater\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"version\": 42\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"suppressions\"\n },\n {\n \"attributes\": {\n \"creation_date\": -43845730,\n \"creator\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"editable\": true,\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"update_date\": 25149973,\n \"updater\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"version\": 42\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"suppressions\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get suppressions affecting future rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": true,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 3600,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 0,\n \"maxSignalDuration\": 21600,\n \"newValueOptions\": {\n \"forgetAfter\": 1,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"dolor ea commodo\",\n \"incididunt dolore\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"dolor minim aliquip veniam eiusmod\",\n \"aute culpa in ex\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"minim\",\n \"non dolor\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"id eu minim nisi\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"aute occaecat veniam\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"labore reprehen\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"nisi culpa\",\n \"logFieldPath\": \"ea deserunt minim\",\n \"ruleQueryName\": \"occaecat eiusmod dolor\",\n \"tableName\": \"ad exercitation do\"\n },\n {\n \"checkPresence\": false,\n \"columnName\": \"esse\",\n \"logFieldPath\": \"quis in\",\n \"ruleQueryName\": \"cillum veniam minim sed\",\n \"tableName\": \"occaecat\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"workload_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
"rules"
]
},
"description": "Get the list of suppressions that would affect a rule."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": true,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 3600,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 0,\n \"maxSignalDuration\": 21600,\n \"newValueOptions\": {\n \"forgetAfter\": 1,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"dolor ea commodo\",\n \"incididunt dolore\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"dolor minim aliquip veniam eiusmod\",\n \"aute culpa in ex\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"minim\",\n \"non dolor\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"id eu minim nisi\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"aute occaecat veniam\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"labore reprehen\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"nisi culpa\",\n \"logFieldPath\": \"ea deserunt minim\",\n \"ruleQueryName\": \"occaecat eiusmod dolor\",\n \"tableName\": \"ad exercitation do\"\n },\n {\n \"checkPresence\": false,\n \"columnName\": \"esse\",\n \"logFieldPath\": \"quis in\",\n \"ruleQueryName\": \"cillum veniam minim sed\",\n \"tableName\": \"occaecat\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"workload_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
"rules"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"creation_date\": -21123725,\n \"creator\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"editable\": true,\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"update_date\": -35750263,\n \"updater\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"version\": 42\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"suppressions\"\n },\n {\n \"attributes\": {\n \"creation_date\": -43845730,\n \"creator\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"editable\": true,\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"update_date\": 25149973,\n \"updater\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"version\": 42\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"suppressions\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": true,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 3600,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 0,\n \"maxSignalDuration\": 21600,\n \"newValueOptions\": {\n \"forgetAfter\": 1,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"dolor ea commodo\",\n \"incididunt dolore\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"dolor minim aliquip veniam eiusmod\",\n \"aute culpa in ex\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"minim\",\n \"non dolor\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"id eu minim nisi\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"aute occaecat veniam\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"labore reprehen\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"nisi culpa\",\n \"logFieldPath\": \"ea deserunt minim\",\n \"ruleQueryName\": \"occaecat eiusmod dolor\",\n \"tableName\": \"ad exercitation do\"\n },\n {\n \"checkPresence\": false,\n \"columnName\": \"esse\",\n \"logFieldPath\": \"quis in\",\n \"ruleQueryName\": \"cillum veniam minim sed\",\n \"tableName\": \"occaecat\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"workload_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
"rules"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": true,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 3600,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 0,\n \"maxSignalDuration\": 21600,\n \"newValueOptions\": {\n \"forgetAfter\": 1,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"dolor ea commodo\",\n \"incididunt dolore\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"dolor minim aliquip veniam eiusmod\",\n \"aute culpa in ex\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"minim\",\n \"non dolor\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"id eu minim nisi\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"aute occaecat veniam\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"labore reprehen\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"nisi culpa\",\n \"logFieldPath\": \"ea deserunt minim\",\n \"ruleQueryName\": \"occaecat eiusmod dolor\",\n \"tableName\": \"ad exercitation do\"\n },\n {\n \"checkPresence\": false,\n \"columnName\": \"esse\",\n \"logFieldPath\": \"quis in\",\n \"ruleQueryName\": \"cillum veniam minim sed\",\n \"tableName\": \"occaecat\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"workload_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
"rules"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": true,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 3600,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 0,\n \"maxSignalDuration\": 21600,\n \"newValueOptions\": {\n \"forgetAfter\": 1,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"dolor ea commodo\",\n \"incididunt dolore\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"dolor minim aliquip veniam eiusmod\",\n \"aute culpa in ex\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"minim\",\n \"non dolor\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"id eu minim nisi\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"aute occaecat veniam\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"labore reprehen\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"nisi culpa\",\n \"logFieldPath\": \"ea deserunt minim\",\n \"ruleQueryName\": \"occaecat eiusmod dolor\",\n \"tableName\": \"ad exercitation do\"\n },\n {\n \"checkPresence\": false,\n \"columnName\": \"esse\",\n \"logFieldPath\": \"quis in\",\n \"ruleQueryName\": \"cillum veniam minim sed\",\n \"tableName\": \"occaecat\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"workload_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
"rules"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a suppression rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"version\": 551882175\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Update a specific suppression rule."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"version\": 551882175\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"creation_date\": 44860601,\n \"creator\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"editable\": true,\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"update_date\": -5607722,\n \"updater\": {\n \"handle\": \"john.doe@datadoghq.com\",\n \"name\": \"John Doe\"\n },\n \"version\": 42\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"suppressions\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"version\": 551882175\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"version\": 551882175\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"version\": 551882175\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"version\": 551882175\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"version\": 551882175\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/:suppression_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
":suppression_id"
],
"variable": [
{
"key": "suppression_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Validate a suppression rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"version\": 551882175\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/validation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
"validation"
]
},
"description": "Validate a suppression rule."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"version\": 551882175\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/validation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
"validation"
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"version\": 551882175\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/validation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
"validation"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"version\": 551882175\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/validation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
"validation"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"suppressions\",\n \"attributes\": {\n \"data_exclusion_query\": \"source:cloudtrail account_id:12345\",\n \"description\": \"This rule suppresses low-severity signals in staging environments.\",\n \"enabled\": true,\n \"expiration_date\": 1703187336000,\n \"name\": \"Custom suppression\",\n \"rule_query\": \"type:log_detection source:cloudtrail\",\n \"start_date\": 1703187336000,\n \"suppression_query\": \"env:staging status:low\",\n \"version\": 551882175\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/suppressions/validation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"suppressions",
"validation"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Add a security signal to an incident",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"incident_id\": 2066,\n \"add_to_signal_timeline\": true,\n \"version\": 0\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/security_analytics/signals/:signal_id/add_to_incident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"security_analytics",
"signals",
":signal_id",
"add_to_incident"
],
"variable": [
{
"key": "signal_id",
"value": "fugiat id"
}
]
},
"description": "Add a security signal to an incident. This makes it possible to search for signals by incident within the signal explorer and to view the signals on the incident timeline."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"incident_id\": 2066,\n \"add_to_signal_timeline\": true,\n \"version\": 0\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/security_analytics/signals/:signal_id/add_to_incident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"security_analytics",
"signals",
":signal_id",
"add_to_incident"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"status\": \"aute vol\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"incident_id\": 2066,\n \"add_to_signal_timeline\": true,\n \"version\": 0\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/security_analytics/signals/:signal_id/add_to_incident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"security_analytics",
"signals",
":signal_id",
"add_to_incident"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"incident_id\": 2066,\n \"add_to_signal_timeline\": true,\n \"version\": 0\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/security_analytics/signals/:signal_id/add_to_incident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"security_analytics",
"signals",
":signal_id",
"add_to_incident"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"incident_id\": 2066,\n \"add_to_signal_timeline\": true,\n \"version\": 0\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/security_analytics/signals/:signal_id/add_to_incident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"security_analytics",
"signals",
":signal_id",
"add_to_incident"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"incident_id\": 2066,\n \"add_to_signal_timeline\": true,\n \"version\": 0\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/security_analytics/signals/:signal_id/add_to_incident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"security_analytics",
"signals",
":signal_id",
"add_to_incident"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Change the triage state of a security signal",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"state\": \"open\",\n \"archive_comment\": \"in\",\n \"archive_reason\": \"investigated_case_opened\",\n \"version\": -40481768\n },\n \"id\": {\n \"description\": \"The unique ID of the security signal.\"\n },\n \"type\": \"signal_metadata\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/state",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"state"
],
"variable": [
{
"key": "signal_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Change the triage state of a security signal."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"state\": \"open\",\n \"archive_comment\": \"in\",\n \"archive_reason\": \"investigated_case_opened\",\n \"version\": -40481768\n },\n \"id\": {\n \"description\": \"The unique ID of the security signal.\"\n },\n \"type\": \"signal_metadata\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/state",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"state"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"assignee\": {\n \"uuid\": \"773b045d-ccf8-4808-bd3b-955ef6a8c940\",\n \"handle\": \"aliqua cupidatat cillum commodo\",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"id\": 47208238,\n \"name\": \"nulla sed sit officia a\"\n },\n \"state\": \"open\",\n \"incident_ids\": [\n 2066\n ],\n \"archive_comment\": \"deserunt fugiat aute dolor\",\n \"archive_comment_timestamp\": 81712675,\n \"archive_comment_user\": {\n \"uuid\": \"773b045d-ccf8-4808-bd3b-955ef6a8c940\",\n \"handle\": \"ad Except\",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"id\": -54134050,\n \"name\": \"ea Lorem veniam\"\n },\n \"archive_reason\": \"investigated_case_opened\",\n \"state_update_timestamp\": 65728848,\n \"state_update_user\": {\n \"uuid\": \"773b045d-ccf8-4808-bd3b-955ef6a8c940\",\n \"handle\": \"proident \",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"id\": 6700913,\n \"name\": \"magna in\"\n }\n },\n \"id\": \"non occaecat tempor in id\",\n \"type\": \"signal_metadata\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"state\": \"open\",\n \"archive_comment\": \"in\",\n \"archive_reason\": \"investigated_case_opened\",\n \"version\": -40481768\n },\n \"id\": {\n \"description\": \"The unique ID of the security signal.\"\n },\n \"type\": \"signal_metadata\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/state",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"state"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"state\": \"open\",\n \"archive_comment\": \"in\",\n \"archive_reason\": \"investigated_case_opened\",\n \"version\": -40481768\n },\n \"id\": {\n \"description\": \"The unique ID of the security signal.\"\n },\n \"type\": \"signal_metadata\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/state",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"state"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"state\": \"open\",\n \"archive_comment\": \"in\",\n \"archive_reason\": \"investigated_case_opened\",\n \"version\": -40481768\n },\n \"id\": {\n \"description\": \"The unique ID of the security signal.\"\n },\n \"type\": \"signal_metadata\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/state",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"state"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"state\": \"open\",\n \"archive_comment\": \"in\",\n \"archive_reason\": \"investigated_case_opened\",\n \"version\": -40481768\n },\n \"id\": {\n \"description\": \"The unique ID of the security signal.\"\n },\n \"type\": \"signal_metadata\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/state",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"state"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a custom framework",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_framework\",\n \"attributes\": {\n \"handle\": \"sec2\",\n \"version\": \"2\",\n \"name\": \"security-framework\",\n \"requirements\": [\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n },\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n }\n ],\n \"description\": \"veniam occaecat amet consequat\",\n \"icon_url\": \"quis est non\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks"
]
},
"description": "Create a custom framework."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_framework\",\n \"attributes\": {\n \"handle\": \"sec2\",\n \"version\": \"2\",\n \"name\": \"security-framework\",\n \"requirements\": [\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n },\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n }\n ],\n \"description\": \"veniam occaecat amet consequat\",\n \"icon_url\": \"quis est non\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"handle-version\",\n \"type\": \"custom_framework\",\n \"attributes\": {\n \"handle\": \"sec2\",\n \"version\": \"2\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_framework\",\n \"attributes\": {\n \"handle\": \"sec2\",\n \"version\": \"2\",\n \"name\": \"security-framework\",\n \"requirements\": [\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n },\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n }\n ],\n \"description\": \"veniam occaecat amet consequat\",\n \"icon_url\": \"quis est non\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_framework\",\n \"attributes\": {\n \"handle\": \"sec2\",\n \"version\": \"2\",\n \"name\": \"security-framework\",\n \"requirements\": [\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n },\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n }\n ],\n \"description\": \"veniam occaecat amet consequat\",\n \"icon_url\": \"quis est non\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_framework\",\n \"attributes\": {\n \"handle\": \"sec2\",\n \"version\": \"2\",\n \"name\": \"security-framework\",\n \"requirements\": [\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n },\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n }\n ],\n \"description\": \"veniam occaecat amet consequat\",\n \"icon_url\": \"quis est non\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_framework\",\n \"attributes\": {\n \"handle\": \"sec2\",\n \"version\": \"2\",\n \"name\": \"security-framework\",\n \"requirements\": [\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n },\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n }\n ],\n \"description\": \"veniam occaecat amet consequat\",\n \"icon_url\": \"quis est non\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a detection rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": true,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 3600,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 0,\n \"maxSignalDuration\": 21600,\n \"newValueOptions\": {\n \"forgetAfter\": 1,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"dolor ea commodo\",\n \"incididunt dolore\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"dolor minim aliquip veniam eiusmod\",\n \"aute culpa in ex\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"minim\",\n \"non dolor\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"id eu minim nisi\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"aute occaecat veniam\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"labore reprehen\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"nisi culpa\",\n \"logFieldPath\": \"ea deserunt minim\",\n \"ruleQueryName\": \"occaecat eiusmod dolor\",\n \"tableName\": \"ad exercitation do\"\n },\n {\n \"checkPresence\": false,\n \"columnName\": \"esse\",\n \"logFieldPath\": \"quis in\",\n \"ruleQueryName\": \"cillum veniam minim sed\",\n \"tableName\": \"occaecat\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"workload_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules"
]
},
"description": "Create a detection rule."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": true,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 3600,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 0,\n \"maxSignalDuration\": 21600,\n \"newValueOptions\": {\n \"forgetAfter\": 1,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"dolor ea commodo\",\n \"incididunt dolore\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"dolor minim aliquip veniam eiusmod\",\n \"aute culpa in ex\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"minim\",\n \"non dolor\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"id eu minim nisi\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"aute occaecat veniam\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"labore reprehen\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"nisi culpa\",\n \"logFieldPath\": \"ea deserunt minim\",\n \"ruleQueryName\": \"occaecat eiusmod dolor\",\n \"tableName\": \"ad exercitation do\"\n },\n {\n \"checkPresence\": false,\n \"columnName\": \"esse\",\n \"logFieldPath\": \"quis in\",\n \"ruleQueryName\": \"cillum veniam minim sed\",\n \"tableName\": \"occaecat\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"workload_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"cases\": [\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"incididunt ut\",\n \"ut_4f_\": {},\n \"magna6be\": {},\n \"enimb0\": {}\n },\n \"type\": \"block_user\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"amet culpa minim\",\n \"consequat_27\": {},\n \"essea\": {}\n },\n \"type\": \"block_user\"\n }\n ],\n \"condition\": \"amet ad\",\n \"customStatus\": \"critical\",\n \"name\": \"sint\",\n \"notifications\": [\n \"deserunt nisi\",\n \"qui irure\"\n ],\n \"status\": \"critical\"\n },\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"ut id\",\n \"elit_11\": {},\n \"aliqua80\": {}\n },\n \"type\": \"user_behavior\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"occaecat irure ex\"\n },\n \"type\": \"flag_ip\"\n }\n ],\n \"condition\": \"in nostrud\",\n \"customStatus\": \"critical\",\n \"name\": \"cillum in\",\n \"notifications\": [\n \"incididunt officia est\",\n \"qui irure nulla ea eiusmod\"\n ],\n \"status\": \"critical\"\n }\n ],\n \"complianceSignalOptions\": {\n \"defaultActivationStatus\": false,\n \"defaultGroupByFields\": [\n \"sunt eu Duis\",\n \"\"\n ],\n \"userActivationStatus\": false,\n \"userGroupByFields\": [\n \"laboris sunt\",\n \"fugiat aute\"\n ]\n },\n \"createdAt\": 96370409,\n \"creationAuthorId\": 9036589,\n \"customMessage\": \"mollit nisi officia nostrud sint\",\n \"customName\": \"sunt cillum id occaecat labore\",\n \"defaultTags\": [\n \"security:attacks\"\n ],\n \"deprecationDate\": 10214904,\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"occaecat cillum dolore ex\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"dolore laborum\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": false,\n \"id\": \"commodo reprehenderit officia p\",\n \"isDefault\": false,\n \"isDeleted\": true,\n \"isEnabled\": true,\n \"message\": \"anim quis in\",\n \"name\": \"sunt non amet\",\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_detection\",\n \"evaluationWindow\": 10800,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 1800,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 7,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"sint sed\",\n \"id dolore\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"anim in\",\n \"mollit id ex\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"in anim\",\n \"nulla occaecat dolore ex\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"in aute anim qui\"\n }\n },\n \"queries\": [\n {\n \"aggregation\": \"event_count\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"ex eu\",\n \"qui ut\"\n ],\n \"groupByFields\": [\n \"eiusmod commodo do\",\n \"in\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"non voluptate reprehenderit veniam\",\n \"metrics\": [\n \"Duis\",\n \"irure dolor exercitation aliquip tempor\"\n ],\n \"name\": \"s\",\n \"query\": \"a > 3\"\n },\n {\n \"aggregation\": \"new_value\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"non\",\n \"consequat magna enim cupidatat\"\n ],\n \"groupByFields\": [\n \"eiusmod anim proident\",\n \"consectetur\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"ea cillum ipsum cupidatat sit\",\n \"metrics\": [\n \"ullamco labore\",\n \"do esse\"\n ],\n \"name\": \"dolor deserunt Ut consectetur\",\n \"query\": \"a > 3\"\n }\n ],\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"do dolor occaecat adipisicing\",\n \"logFieldPath\": \"exercitation cupidatat elit\",\n \"ruleQueryName\": \"id aliquip commodo\",\n \"tableName\": \"nulla Duis eu aliquip\"\n },\n {\n \"checkPresence\": false,\n \"columnName\": \"aute\",\n \"logFieldPath\": \"ipsum sed amet deserunt est\",\n \"ruleQueryName\": \"cillum veniam culpa\",\n \"tableName\": \"minim do\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"occaecat sint laborum\",\n \"officia reprehenderit quis eiusmod\"\n ],\n \"type\": \"application_security\",\n \"updateAuthorId\": 5877901,\n \"updatedAt\": 59536653,\n \"version\": 75420236\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": true,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 3600,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 0,\n \"maxSignalDuration\": 21600,\n \"newValueOptions\": {\n \"forgetAfter\": 1,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"dolor ea commodo\",\n \"incididunt dolore\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"dolor minim aliquip veniam eiusmod\",\n \"aute culpa in ex\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"minim\",\n \"non dolor\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"id eu minim nisi\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"aute occaecat veniam\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"labore reprehen\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"nisi culpa\",\n \"logFieldPath\": \"ea deserunt minim\",\n \"ruleQueryName\": \"occaecat eiusmod dolor\",\n \"tableName\": \"ad exercitation do\"\n },\n {\n \"checkPresence\": false,\n \"columnName\": \"esse\",\n \"logFieldPath\": \"quis in\",\n \"ruleQueryName\": \"cillum veniam minim sed\",\n \"tableName\": \"occaecat\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"workload_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": true,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 3600,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 0,\n \"maxSignalDuration\": 21600,\n \"newValueOptions\": {\n \"forgetAfter\": 1,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"dolor ea commodo\",\n \"incididunt dolore\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"dolor minim aliquip veniam eiusmod\",\n \"aute culpa in ex\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"minim\",\n \"non dolor\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"id eu minim nisi\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"aute occaecat veniam\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"labore reprehen\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"nisi culpa\",\n \"logFieldPath\": \"ea deserunt minim\",\n \"ruleQueryName\": \"occaecat eiusmod dolor\",\n \"tableName\": \"ad exercitation do\"\n },\n {\n \"checkPresence\": false,\n \"columnName\": \"esse\",\n \"logFieldPath\": \"quis in\",\n \"ruleQueryName\": \"cillum veniam minim sed\",\n \"tableName\": \"occaecat\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"workload_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": true,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 3600,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 0,\n \"maxSignalDuration\": 21600,\n \"newValueOptions\": {\n \"forgetAfter\": 1,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"dolor ea commodo\",\n \"incididunt dolore\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"dolor minim aliquip veniam eiusmod\",\n \"aute culpa in ex\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"minim\",\n \"non dolor\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"id eu minim nisi\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"aute occaecat veniam\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"labore reprehen\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"nisi culpa\",\n \"logFieldPath\": \"ea deserunt minim\",\n \"ruleQueryName\": \"occaecat eiusmod dolor\",\n \"tableName\": \"ad exercitation do\"\n },\n {\n \"checkPresence\": false,\n \"columnName\": \"esse\",\n \"logFieldPath\": \"quis in\",\n \"ruleQueryName\": \"cillum veniam minim sed\",\n \"tableName\": \"occaecat\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"workload_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a custom framework",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks/:handle/:version",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks",
":handle",
":version"
],
"variable": [
{
"key": "handle",
"value": "consectetur consequat dolor"
},
{
"key": "version",
"value": "consectetur consequat dolor"
}
]
},
"description": "Delete a custom framework."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks/:handle/:version",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks",
":handle",
":version"
],
"variable": [
{
"key": "handle"
},
{
"key": "version"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"sec2\",\n \"version\": \"2\",\n \"name\": \"security-framework\",\n \"description\": \"this is a security description\",\n \"icon_url\": \"https://example.com/icon.png\"\n },\n \"id\": \"handle-version\",\n \"type\": \"custom_framework\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks/:handle/:version",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks",
":handle",
":version"
],
"variable": [
{
"key": "handle"
},
{
"key": "version"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks/:handle/:version",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks",
":handle",
":version"
],
"variable": [
{
"key": "handle"
},
{
"key": "version"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks/:handle/:version",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks",
":handle",
":version"
],
"variable": [
{
"key": "handle"
},
{
"key": "version"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a custom framework",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks/:handle/:version",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks",
":handle",
":version"
],
"variable": [
{
"key": "handle",
"value": "consectetur consequat dolor"
},
{
"key": "version",
"value": "consectetur consequat dolor"
}
]
},
"description": "Get a custom framework."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks/:handle/:version",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks",
":handle",
":version"
],
"variable": [
{
"key": "handle"
},
{
"key": "version"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"handle-version\",\n \"type\": \"custom_framework\",\n \"attributes\": {\n \"handle\": \"sec2\",\n \"version\": \"2\",\n \"name\": \"security-framework\",\n \"requirements\": [\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n },\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n }\n ],\n \"icon_url\": \"https://example.com/icon.png\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks/:handle/:version",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks",
":handle",
":version"
],
"variable": [
{
"key": "handle"
},
{
"key": "version"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks/:handle/:version",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks",
":handle",
":version"
],
"variable": [
{
"key": "handle"
},
{
"key": "version"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks/:handle/:version",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks",
":handle",
":version"
],
"variable": [
{
"key": "handle"
},
{
"key": "version"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List rules",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules?page[size]=10&page[number]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
}
]
},
"description": "List rules."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules?page[size]=10&page[number]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"cases\": [\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"officia\"\n },\n \"type\": \"block_user\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"in tempor ad laboris\",\n \"ut_7f1\": {},\n \"in_7e\": {}\n },\n \"type\": \"block_ip\"\n }\n ],\n \"condition\": \"Excepteur sed quis ad\",\n \"customStatus\": \"critical\",\n \"name\": \"culpa ips\",\n \"notifications\": [\n \"commodo consequat reprehenderit\",\n \"consequat mollit\"\n ],\n \"status\": \"critical\"\n },\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"do dolore\"\n },\n \"type\": \"flag_ip\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"elit officia in aliquip cupidatat\"\n },\n \"type\": \"user_behavior\"\n }\n ],\n \"condition\": \"dolor dolore fugiat occaecat\",\n \"customStatus\": \"critical\",\n \"name\": \"nisi dolore anim\",\n \"notifications\": [\n \"occaec\",\n \"officia dolore in deserunt\"\n ],\n \"status\": \"critical\"\n }\n ],\n \"complianceSignalOptions\": {\n \"defaultActivationStatus\": false,\n \"defaultGroupByFields\": [\n \"tempor ad\",\n \"id fugiat\"\n ],\n \"userActivationStatus\": false,\n \"userGroupByFields\": [\n \"commodo\",\n \"dolor ex occaec\"\n ]\n },\n \"createdAt\": -52870889,\n \"creationAuthorId\": 61294484,\n \"customMessage\": \"aliqua\",\n \"customName\": \"cillum in voluptate\",\n \"defaultTags\": [\n \"security:attacks\"\n ],\n \"deprecationDate\": -68549708,\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"culpa et\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"culpa mollit tempor\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"id\": \"in veniam repre\",\n \"isDefault\": true,\n \"isDeleted\": true,\n \"isEnabled\": true,\n \"message\": \"laboris cillum non\",\n \"name\": \"pariatur dolor\",\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\",\n \"consectetur_8\": {},\n \"dolor_83\": {},\n \"occaecat4_\": {}\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"hardcoded\",\n \"evaluationWindow\": 43200,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 10800,\n \"maxSignalDuration\": 0,\n \"newValueOptions\": {\n \"forgetAfter\": 1,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"Excepteur est ut\",\n \"ullamco\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"commodo qui\",\n \"in laborum voluptate\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"dolore qui\",\n \"occaecat nulla\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"quis non sunt\"\n }\n },\n \"queries\": [\n {\n \"aggregation\": \"count\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"do quis minim esse\",\n \"consectetur do minim\"\n ],\n \"groupByFields\": [\n \"dolore enim non adipisicing\",\n \"mollit eiusmod consectetur Excepteur\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"consequat labore ut sed\",\n \"metrics\": [\n \"minim dolore nulla mollit ut\",\n \"ea anim tempor\"\n ],\n \"name\": \"amet Lorem\",\n \"query\": \"a > 3\"\n },\n {\n \"aggregation\": \"max\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"proident\",\n \"Lore\"\n ],\n \"groupByFields\": [\n \"elit magna aliquip\",\n \"nostrud veniam nulla consequat\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"est nulla exercitation commodo velit\",\n \"metrics\": [\n \"sunt mollit velit veniam\",\n \"adipisicing\"\n ],\n \"name\": \"nisi labore\",\n \"query\": \"a > 3\"\n }\n ],\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"nostrud in officia dolor\",\n \"logFieldPath\": \"non in dolor\",\n \"ruleQueryName\": \"Duis esse nulla laboris\",\n \"tableName\": \"dolor dolore dolor officia\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ullamco eiusmo\",\n \"logFieldPath\": \"cillum ullamco in veniam\",\n \"ruleQueryName\": \"ut in est adipisicing\",\n \"tableName\": \"enim exercitation\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"Ut ipsum labore mollit\",\n \"nulla consectetur ut\"\n ],\n \"type\": \"log_detection\",\n \"updateAuthorId\": -69141205,\n \"updatedAt\": 71620564,\n \"version\": -5882706\n },\n {\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"cases\": [\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"ullamco proident\",\n \"amet7e_\": {},\n \"eu66\": {},\n \"ea_5\": {}\n },\n \"type\": \"flag_ip\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"adipisicing dolor exercitation elit\",\n \"nulla_94\": {}\n },\n \"type\": \"block_user\"\n }\n ],\n \"condition\": \"sunt\",\n \"customStatus\": \"critical\",\n \"name\": \"eiusmod ullamco\",\n \"notifications\": [\n \"veniam Excepteur dolor\",\n \"id ea ad do ipsum\"\n ],\n \"status\": \"critical\"\n },\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"tempor esse laborum Ut\"\n },\n \"type\": \"block_ip\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"Excepteur dolor\",\n \"quis_f9\": {},\n \"nulla_3d\": {}\n },\n \"type\": \"block_ip\"\n }\n ],\n \"condition\": \"reprehenderit aute dolor in deserunt\",\n \"customStatus\": \"critical\",\n \"name\": \"labore magna\",\n \"notifications\": [\n \"Excepteur do\",\n \"amet ut eu\"\n ],\n \"status\": \"critical\"\n }\n ],\n \"complianceSignalOptions\": {\n \"defaultActivationStatus\": true,\n \"defaultGroupByFields\": [\n \"culpa dolor in tempor\",\n \"veniam id\"\n ],\n \"userActivationStatus\": true,\n \"userGroupByFields\": [\n \"id\",\n \"labore \"\n ]\n },\n \"createdAt\": 47235540,\n \"creationAuthorId\": -82426103,\n \"customMessage\": \"aliquip consequat nulla magna\",\n \"customName\": \"cupidatat\",\n \"defaultTags\": [\n \"security:attacks\"\n ],\n \"deprecationDate\": 74295737,\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"veniam adipisicing officia\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"esse sed\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"id\": \"Lorem labore qui\",\n \"isDefault\": false,\n \"isDeleted\": false,\n \"isEnabled\": true,\n \"message\": \"tempor incididunt eu anim dolore\",\n \"name\": \"sed laboris consectetur qui non\",\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": true,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\",\n \"ullamco9d1\": {}\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 600,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 900,\n \"maxSignalDuration\": 7200,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"minim et reprehenderi\",\n \"nostrud in non\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"qui cillum nisi\",\n \"id non\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"est dolor\",\n \"veniam\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"ad\"\n }\n },\n \"queries\": [\n {\n \"aggregation\": \"geo_data\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"ad ut Ut ut\",\n \"non dolor cillum\"\n ],\n \"groupByFields\": [\n \"cillum cupidatat\",\n \"ipsum minim qui\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"deserunt laborum esse\",\n \"metrics\": [\n \"q\",\n \"ea commodo laborum\"\n ],\n \"name\": \"elit proident\",\n \"query\": \"a > 3\"\n },\n {\n \"aggregation\": \"max\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"Duis\",\n \"in veniam fugiat elit\"\n ],\n \"groupByFields\": [\n \"officia aliqua velit\",\n \"consectetur\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"elit dese\",\n \"metrics\": [\n \"in nostrud\",\n \"Excepteur sint amet nulla sit\"\n ],\n \"name\": \"nulla in quis\",\n \"query\": \"a > 3\"\n }\n ],\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"dolor dolore amet\",\n \"logFieldPath\": \"in cillum sed\",\n \"ruleQueryName\": \"in Ut ea mollit\",\n \"tableName\": \"nostrud voluptate sit et\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"id aliquip reprehenderit\",\n \"logFieldPath\": \"sit minim\",\n \"ruleQueryName\": \"sunt deserunt ea\",\n \"tableName\": \"enim sit sint ullamco irure\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"proident laborum\",\n \"voluptate conseq\"\n ],\n \"type\": \"application_security\",\n \"updateAuthorId\": 58511329,\n \"updatedAt\": -79975246,\n \"version\": 91547497\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": 39451271,\n \"total_filtered_count\": -83756939\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules?page[size]=10&page[number]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules?page[size]=10&page[number]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a custom framework",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_framework\",\n \"attributes\": {\n \"handle\": \"sec2\",\n \"version\": \"2\",\n \"name\": \"security-framework\",\n \"requirements\": [\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n },\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n }\n ],\n \"description\": \"tempor eu veniam elit ex\",\n \"icon_url\": \"incididunt commodo\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks/:handle/:version",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks",
":handle",
":version"
],
"variable": [
{
"key": "handle",
"value": "consectetur consequat dolor"
},
{
"key": "version",
"value": "consectetur consequat dolor"
}
]
},
"description": "Update a custom framework."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_framework\",\n \"attributes\": {\n \"handle\": \"sec2\",\n \"version\": \"2\",\n \"name\": \"security-framework\",\n \"requirements\": [\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n },\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n }\n ],\n \"description\": \"tempor eu veniam elit ex\",\n \"icon_url\": \"incididunt commodo\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks/:handle/:version",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks",
":handle",
":version"
],
"variable": [
{
"key": "handle"
},
{
"key": "version"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"handle-version\",\n \"type\": \"custom_framework\",\n \"attributes\": {\n \"handle\": \"sec2\",\n \"version\": \"2\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_framework\",\n \"attributes\": {\n \"handle\": \"sec2\",\n \"version\": \"2\",\n \"name\": \"security-framework\",\n \"requirements\": [\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n },\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n }\n ],\n \"description\": \"tempor eu veniam elit ex\",\n \"icon_url\": \"incididunt commodo\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks/:handle/:version",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks",
":handle",
":version"
],
"variable": [
{
"key": "handle"
},
{
"key": "version"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_framework\",\n \"attributes\": {\n \"handle\": \"sec2\",\n \"version\": \"2\",\n \"name\": \"security-framework\",\n \"requirements\": [\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n },\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n }\n ],\n \"description\": \"tempor eu veniam elit ex\",\n \"icon_url\": \"incididunt commodo\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks/:handle/:version",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks",
":handle",
":version"
],
"variable": [
{
"key": "handle"
},
{
"key": "version"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"custom_framework\",\n \"attributes\": {\n \"handle\": \"sec2\",\n \"version\": \"2\",\n \"name\": \"security-framework\",\n \"requirements\": [\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n },\n {\n \"name\": \"criteria\",\n \"controls\": [\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n },\n {\n \"name\": \"A1.2\",\n \"rules_id\": [\n \"[\\\"def-000-abc\\\"]\"\n ]\n }\n ]\n }\n ],\n \"description\": \"tempor eu veniam elit ex\",\n \"icon_url\": \"incididunt commodo\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/custom_frameworks/:handle/:version",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"custom_frameworks",
":handle",
":version"
],
"variable": [
{
"key": "handle"
},
{
"key": "version"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a rule's details",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Get a rule's details."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"cases\": [\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"incididunt ut\",\n \"ut_4f_\": {},\n \"magna6be\": {},\n \"enimb0\": {}\n },\n \"type\": \"block_user\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"amet culpa minim\",\n \"consequat_27\": {},\n \"essea\": {}\n },\n \"type\": \"block_user\"\n }\n ],\n \"condition\": \"amet ad\",\n \"customStatus\": \"critical\",\n \"name\": \"sint\",\n \"notifications\": [\n \"deserunt nisi\",\n \"qui irure\"\n ],\n \"status\": \"critical\"\n },\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"ut id\",\n \"elit_11\": {},\n \"aliqua80\": {}\n },\n \"type\": \"user_behavior\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"occaecat irure ex\"\n },\n \"type\": \"flag_ip\"\n }\n ],\n \"condition\": \"in nostrud\",\n \"customStatus\": \"critical\",\n \"name\": \"cillum in\",\n \"notifications\": [\n \"incididunt officia est\",\n \"qui irure nulla ea eiusmod\"\n ],\n \"status\": \"critical\"\n }\n ],\n \"complianceSignalOptions\": {\n \"defaultActivationStatus\": false,\n \"defaultGroupByFields\": [\n \"sunt eu Duis\",\n \"\"\n ],\n \"userActivationStatus\": false,\n \"userGroupByFields\": [\n \"laboris sunt\",\n \"fugiat aute\"\n ]\n },\n \"createdAt\": 96370409,\n \"creationAuthorId\": 9036589,\n \"customMessage\": \"mollit nisi officia nostrud sint\",\n \"customName\": \"sunt cillum id occaecat labore\",\n \"defaultTags\": [\n \"security:attacks\"\n ],\n \"deprecationDate\": 10214904,\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"occaecat cillum dolore ex\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"dolore laborum\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": false,\n \"id\": \"commodo reprehenderit officia p\",\n \"isDefault\": false,\n \"isDeleted\": true,\n \"isEnabled\": true,\n \"message\": \"anim quis in\",\n \"name\": \"sunt non amet\",\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_detection\",\n \"evaluationWindow\": 10800,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 1800,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 7,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"sint sed\",\n \"id dolore\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"anim in\",\n \"mollit id ex\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"in anim\",\n \"nulla occaecat dolore ex\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"in aute anim qui\"\n }\n },\n \"queries\": [\n {\n \"aggregation\": \"event_count\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"ex eu\",\n \"qui ut\"\n ],\n \"groupByFields\": [\n \"eiusmod commodo do\",\n \"in\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"non voluptate reprehenderit veniam\",\n \"metrics\": [\n \"Duis\",\n \"irure dolor exercitation aliquip tempor\"\n ],\n \"name\": \"s\",\n \"query\": \"a > 3\"\n },\n {\n \"aggregation\": \"new_value\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"non\",\n \"consequat magna enim cupidatat\"\n ],\n \"groupByFields\": [\n \"eiusmod anim proident\",\n \"consectetur\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"ea cillum ipsum cupidatat sit\",\n \"metrics\": [\n \"ullamco labore\",\n \"do esse\"\n ],\n \"name\": \"dolor deserunt Ut consectetur\",\n \"query\": \"a > 3\"\n }\n ],\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"do dolor occaecat adipisicing\",\n \"logFieldPath\": \"exercitation cupidatat elit\",\n \"ruleQueryName\": \"id aliquip commodo\",\n \"tableName\": \"nulla Duis eu aliquip\"\n },\n {\n \"checkPresence\": false,\n \"columnName\": \"aute\",\n \"logFieldPath\": \"ipsum sed amet deserunt est\",\n \"ruleQueryName\": \"cillum veniam culpa\",\n \"tableName\": \"minim do\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"occaecat sint laborum\",\n \"officia reprehenderit quis eiusmod\"\n ],\n \"type\": \"application_security\",\n \"updateAuthorId\": 5877901,\n \"updatedAt\": 59536653,\n \"version\": 75420236\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Modify the triage assignee of a security signal",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"assignee\": {\n \"uuid\": \"773b045d-ccf8-4808-bd3b-955ef6a8c940\",\n \"handle\": \"aliquip sed nulla veniam\",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"id\": -8821266,\n \"name\": \"officia est Ut\"\n },\n \"version\": -80067255\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/assignee",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"assignee"
],
"variable": [
{
"key": "signal_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Modify the triage assignee of a security signal."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"assignee\": {\n \"uuid\": \"773b045d-ccf8-4808-bd3b-955ef6a8c940\",\n \"handle\": \"aliquip sed nulla veniam\",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"id\": -8821266,\n \"name\": \"officia est Ut\"\n },\n \"version\": -80067255\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/assignee",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"assignee"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"assignee\": {\n \"uuid\": \"773b045d-ccf8-4808-bd3b-955ef6a8c940\",\n \"handle\": \"aliqua cupidatat cillum commodo\",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"id\": 47208238,\n \"name\": \"nulla sed sit officia a\"\n },\n \"state\": \"open\",\n \"incident_ids\": [\n 2066\n ],\n \"archive_comment\": \"deserunt fugiat aute dolor\",\n \"archive_comment_timestamp\": 81712675,\n \"archive_comment_user\": {\n \"uuid\": \"773b045d-ccf8-4808-bd3b-955ef6a8c940\",\n \"handle\": \"ad Except\",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"id\": -54134050,\n \"name\": \"ea Lorem veniam\"\n },\n \"archive_reason\": \"investigated_case_opened\",\n \"state_update_timestamp\": 65728848,\n \"state_update_user\": {\n \"uuid\": \"773b045d-ccf8-4808-bd3b-955ef6a8c940\",\n \"handle\": \"proident \",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"id\": 6700913,\n \"name\": \"magna in\"\n }\n },\n \"id\": \"non occaecat tempor in id\",\n \"type\": \"signal_metadata\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"assignee\": {\n \"uuid\": \"773b045d-ccf8-4808-bd3b-955ef6a8c940\",\n \"handle\": \"aliquip sed nulla veniam\",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"id\": -8821266,\n \"name\": \"officia est Ut\"\n },\n \"version\": -80067255\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/assignee",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"assignee"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"assignee\": {\n \"uuid\": \"773b045d-ccf8-4808-bd3b-955ef6a8c940\",\n \"handle\": \"aliquip sed nulla veniam\",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"id\": -8821266,\n \"name\": \"officia est Ut\"\n },\n \"version\": -80067255\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/assignee",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"assignee"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"assignee\": {\n \"uuid\": \"773b045d-ccf8-4808-bd3b-955ef6a8c940\",\n \"handle\": \"aliquip sed nulla veniam\",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"id\": -8821266,\n \"name\": \"officia est Ut\"\n },\n \"version\": -80067255\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/assignee",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"assignee"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"assignee\": {\n \"uuid\": \"773b045d-ccf8-4808-bd3b-955ef6a8c940\",\n \"handle\": \"aliquip sed nulla veniam\",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"id\": -8821266,\n \"name\": \"officia est Ut\"\n },\n \"version\": -80067255\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/assignee",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"assignee"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update an existing rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"cases\": [\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"dolor commod\"\n },\n \"type\": \"block_user\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"nulla\"\n },\n \"type\": \"block_user\"\n }\n ],\n \"condition\": \"ut dolor incididunt fugiat\",\n \"customStatus\": \"critical\",\n \"name\": \"ullamco pariatur\",\n \"notifications\": [\n \"est in aliqua magna consequat\",\n \"aute fugiat consequat\"\n ],\n \"status\": \"critical\"\n },\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"Excepteur u\",\n \"cillum68\": {},\n \"eu4_\": {},\n \"mollit_a\": {}\n },\n \"type\": \"block_ip\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"ad adipisicing velit\"\n },\n \"type\": \"block_ip\"\n }\n ],\n \"condition\": \"sed eu\",\n \"customStatus\": \"critical\",\n \"name\": \"sed deserunt\",\n \"notifications\": [\n \"consequat id\",\n \"aliquip ad amet tempor\"\n ],\n \"status\": \"critical\"\n }\n ],\n \"complianceSignalOptions\": {\n \"defaultActivationStatus\": true,\n \"defaultGroupByFields\": [\n \"consequat elit dolore ullamco\",\n \"elit cupidatat aliquip id\"\n ],\n \"userActivationStatus\": true,\n \"userGroupByFields\": [\n \"consequat magna ex\",\n \"non fugiat ipsum\"\n ]\n },\n \"customMessage\": \"officia\",\n \"customName\": \"labore aute velit id\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"cillum sed velit\"\n },\n {\n \"action\": \"require\",\n \"query\": \"eu elit incididunt\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"isEnabled\": false,\n \"message\": \"dolor laboris in id\",\n \"name\": \"id ex nostrud dolore mollit\",\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\",\n \"aliqua_0\": {},\n \"voluptate6\": {}\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 0,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 43200,\n \"maxSignalDuration\": 10800,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"Excepteur dolore in in\",\n \"magna dolore laborum cupidatat nisi\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"proident Lorem\",\n \"quis consequat velit eu ad\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"in commodo quis enim\",\n \"consequat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"sunt id nostrud\"\n }\n },\n \"queries\": [\n {\n \"aggregation\": \"sum\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"esse aliquip aute ullamco\",\n \"exercita\"\n ],\n \"groupByFields\": [\n \"esse est Lorem\",\n \"elit sint\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"non cupidatat aliquip qui\",\n \"metrics\": [\n \"Ut\",\n \"ullamco minim elit\"\n ],\n \"name\": \"sit sed cillum cupidatat Lorem\",\n \"query\": \"a > 3\"\n },\n {\n \"aggregation\": \"event_count\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"dol\",\n \"nisi sunt Excepteur aute\"\n ],\n \"groupByFields\": [\n \"elit fugiat\",\n \"velit ipsum incididunt laboris\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"occaecat non quis\",\n \"metrics\": [\n \"nisi magna nostrud\",\n \"commodo culp\"\n ],\n \"name\": \"elit ullamco aliquip\",\n \"query\": \"a > 3\"\n }\n ],\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"minim et veniam\",\n \"logFieldPath\": \"qui sit reprehenderit\",\n \"ruleQueryName\": \"nisi aute\",\n \"tableName\": \"mollit Ut\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"voluptate aliqua anim aute\",\n \"logFieldPath\": \"qui Lorem\",\n \"ruleQueryName\": \"Excepteur voluptate adipisicing labore\",\n \"tableName\": \"in\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"incididunt dolor sit id tempor\",\n \"sunt aliquip cupidatat\"\n ],\n \"version\": 1\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Update an existing rule. When updating `cases`, `queries` or `options`, the whole field\nmust be included. For example, when modifying a query all queries must be included.\nDefault rules can only be updated to be enabled, to change notifications, or to update\nthe tags (default tags cannot be removed)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"cases\": [\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"dolor commod\"\n },\n \"type\": \"block_user\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"nulla\"\n },\n \"type\": \"block_user\"\n }\n ],\n \"condition\": \"ut dolor incididunt fugiat\",\n \"customStatus\": \"critical\",\n \"name\": \"ullamco pariatur\",\n \"notifications\": [\n \"est in aliqua magna consequat\",\n \"aute fugiat consequat\"\n ],\n \"status\": \"critical\"\n },\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"Excepteur u\",\n \"cillum68\": {},\n \"eu4_\": {},\n \"mollit_a\": {}\n },\n \"type\": \"block_ip\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"ad adipisicing velit\"\n },\n \"type\": \"block_ip\"\n }\n ],\n \"condition\": \"sed eu\",\n \"customStatus\": \"critical\",\n \"name\": \"sed deserunt\",\n \"notifications\": [\n \"consequat id\",\n \"aliquip ad amet tempor\"\n ],\n \"status\": \"critical\"\n }\n ],\n \"complianceSignalOptions\": {\n \"defaultActivationStatus\": true,\n \"defaultGroupByFields\": [\n \"consequat elit dolore ullamco\",\n \"elit cupidatat aliquip id\"\n ],\n \"userActivationStatus\": true,\n \"userGroupByFields\": [\n \"consequat magna ex\",\n \"non fugiat ipsum\"\n ]\n },\n \"customMessage\": \"officia\",\n \"customName\": \"labore aute velit id\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"cillum sed velit\"\n },\n {\n \"action\": \"require\",\n \"query\": \"eu elit incididunt\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"isEnabled\": false,\n \"message\": \"dolor laboris in id\",\n \"name\": \"id ex nostrud dolore mollit\",\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\",\n \"aliqua_0\": {},\n \"voluptate6\": {}\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 0,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 43200,\n \"maxSignalDuration\": 10800,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"Excepteur dolore in in\",\n \"magna dolore laborum cupidatat nisi\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"proident Lorem\",\n \"quis consequat velit eu ad\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"in commodo quis enim\",\n \"consequat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"sunt id nostrud\"\n }\n },\n \"queries\": [\n {\n \"aggregation\": \"sum\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"esse aliquip aute ullamco\",\n \"exercita\"\n ],\n \"groupByFields\": [\n \"esse est Lorem\",\n \"elit sint\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"non cupidatat aliquip qui\",\n \"metrics\": [\n \"Ut\",\n \"ullamco minim elit\"\n ],\n \"name\": \"sit sed cillum cupidatat Lorem\",\n \"query\": \"a > 3\"\n },\n {\n \"aggregation\": \"event_count\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"dol\",\n \"nisi sunt Excepteur aute\"\n ],\n \"groupByFields\": [\n \"elit fugiat\",\n \"velit ipsum incididunt laboris\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"occaecat non quis\",\n \"metrics\": [\n \"nisi magna nostrud\",\n \"commodo culp\"\n ],\n \"name\": \"elit ullamco aliquip\",\n \"query\": \"a > 3\"\n }\n ],\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"minim et veniam\",\n \"logFieldPath\": \"qui sit reprehenderit\",\n \"ruleQueryName\": \"nisi aute\",\n \"tableName\": \"mollit Ut\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"voluptate aliqua anim aute\",\n \"logFieldPath\": \"qui Lorem\",\n \"ruleQueryName\": \"Excepteur voluptate adipisicing labore\",\n \"tableName\": \"in\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"incididunt dolor sit id tempor\",\n \"sunt aliquip cupidatat\"\n ],\n \"version\": 1\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"cases\": [\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"incididunt ut\",\n \"ut_4f_\": {},\n \"magna6be\": {},\n \"enimb0\": {}\n },\n \"type\": \"block_user\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"amet culpa minim\",\n \"consequat_27\": {},\n \"essea\": {}\n },\n \"type\": \"block_user\"\n }\n ],\n \"condition\": \"amet ad\",\n \"customStatus\": \"critical\",\n \"name\": \"sint\",\n \"notifications\": [\n \"deserunt nisi\",\n \"qui irure\"\n ],\n \"status\": \"critical\"\n },\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"ut id\",\n \"elit_11\": {},\n \"aliqua80\": {}\n },\n \"type\": \"user_behavior\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"occaecat irure ex\"\n },\n \"type\": \"flag_ip\"\n }\n ],\n \"condition\": \"in nostrud\",\n \"customStatus\": \"critical\",\n \"name\": \"cillum in\",\n \"notifications\": [\n \"incididunt officia est\",\n \"qui irure nulla ea eiusmod\"\n ],\n \"status\": \"critical\"\n }\n ],\n \"complianceSignalOptions\": {\n \"defaultActivationStatus\": false,\n \"defaultGroupByFields\": [\n \"sunt eu Duis\",\n \"\"\n ],\n \"userActivationStatus\": false,\n \"userGroupByFields\": [\n \"laboris sunt\",\n \"fugiat aute\"\n ]\n },\n \"createdAt\": 96370409,\n \"creationAuthorId\": 9036589,\n \"customMessage\": \"mollit nisi officia nostrud sint\",\n \"customName\": \"sunt cillum id occaecat labore\",\n \"defaultTags\": [\n \"security:attacks\"\n ],\n \"deprecationDate\": 10214904,\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"occaecat cillum dolore ex\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"dolore laborum\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": false,\n \"id\": \"commodo reprehenderit officia p\",\n \"isDefault\": false,\n \"isDeleted\": true,\n \"isEnabled\": true,\n \"message\": \"anim quis in\",\n \"name\": \"sunt non amet\",\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_detection\",\n \"evaluationWindow\": 10800,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 1800,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 7,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"sint sed\",\n \"id dolore\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"anim in\",\n \"mollit id ex\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"in anim\",\n \"nulla occaecat dolore ex\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"in aute anim qui\"\n }\n },\n \"queries\": [\n {\n \"aggregation\": \"event_count\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"ex eu\",\n \"qui ut\"\n ],\n \"groupByFields\": [\n \"eiusmod commodo do\",\n \"in\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"non voluptate reprehenderit veniam\",\n \"metrics\": [\n \"Duis\",\n \"irure dolor exercitation aliquip tempor\"\n ],\n \"name\": \"s\",\n \"query\": \"a > 3\"\n },\n {\n \"aggregation\": \"new_value\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"non\",\n \"consequat magna enim cupidatat\"\n ],\n \"groupByFields\": [\n \"eiusmod anim proident\",\n \"consectetur\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"ea cillum ipsum cupidatat sit\",\n \"metrics\": [\n \"ullamco labore\",\n \"do esse\"\n ],\n \"name\": \"dolor deserunt Ut consectetur\",\n \"query\": \"a > 3\"\n }\n ],\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"do dolor occaecat adipisicing\",\n \"logFieldPath\": \"exercitation cupidatat elit\",\n \"ruleQueryName\": \"id aliquip commodo\",\n \"tableName\": \"nulla Duis eu aliquip\"\n },\n {\n \"checkPresence\": false,\n \"columnName\": \"aute\",\n \"logFieldPath\": \"ipsum sed amet deserunt est\",\n \"ruleQueryName\": \"cillum veniam culpa\",\n \"tableName\": \"minim do\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"occaecat sint laborum\",\n \"officia reprehenderit quis eiusmod\"\n ],\n \"type\": \"application_security\",\n \"updateAuthorId\": 5877901,\n \"updatedAt\": 59536653,\n \"version\": 75420236\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"cases\": [\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"dolor commod\"\n },\n \"type\": \"block_user\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"nulla\"\n },\n \"type\": \"block_user\"\n }\n ],\n \"condition\": \"ut dolor incididunt fugiat\",\n \"customStatus\": \"critical\",\n \"name\": \"ullamco pariatur\",\n \"notifications\": [\n \"est in aliqua magna consequat\",\n \"aute fugiat consequat\"\n ],\n \"status\": \"critical\"\n },\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"Excepteur u\",\n \"cillum68\": {},\n \"eu4_\": {},\n \"mollit_a\": {}\n },\n \"type\": \"block_ip\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"ad adipisicing velit\"\n },\n \"type\": \"block_ip\"\n }\n ],\n \"condition\": \"sed eu\",\n \"customStatus\": \"critical\",\n \"name\": \"sed deserunt\",\n \"notifications\": [\n \"consequat id\",\n \"aliquip ad amet tempor\"\n ],\n \"status\": \"critical\"\n }\n ],\n \"complianceSignalOptions\": {\n \"defaultActivationStatus\": true,\n \"defaultGroupByFields\": [\n \"consequat elit dolore ullamco\",\n \"elit cupidatat aliquip id\"\n ],\n \"userActivationStatus\": true,\n \"userGroupByFields\": [\n \"consequat magna ex\",\n \"non fugiat ipsum\"\n ]\n },\n \"customMessage\": \"officia\",\n \"customName\": \"labore aute velit id\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"cillum sed velit\"\n },\n {\n \"action\": \"require\",\n \"query\": \"eu elit incididunt\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"isEnabled\": false,\n \"message\": \"dolor laboris in id\",\n \"name\": \"id ex nostrud dolore mollit\",\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\",\n \"aliqua_0\": {},\n \"voluptate6\": {}\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 0,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 43200,\n \"maxSignalDuration\": 10800,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"Excepteur dolore in in\",\n \"magna dolore laborum cupidatat nisi\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"proident Lorem\",\n \"quis consequat velit eu ad\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"in commodo quis enim\",\n \"consequat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"sunt id nostrud\"\n }\n },\n \"queries\": [\n {\n \"aggregation\": \"sum\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"esse aliquip aute ullamco\",\n \"exercita\"\n ],\n \"groupByFields\": [\n \"esse est Lorem\",\n \"elit sint\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"non cupidatat aliquip qui\",\n \"metrics\": [\n \"Ut\",\n \"ullamco minim elit\"\n ],\n \"name\": \"sit sed cillum cupidatat Lorem\",\n \"query\": \"a > 3\"\n },\n {\n \"aggregation\": \"event_count\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"dol\",\n \"nisi sunt Excepteur aute\"\n ],\n \"groupByFields\": [\n \"elit fugiat\",\n \"velit ipsum incididunt laboris\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"occaecat non quis\",\n \"metrics\": [\n \"nisi magna nostrud\",\n \"commodo culp\"\n ],\n \"name\": \"elit ullamco aliquip\",\n \"query\": \"a > 3\"\n }\n ],\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"minim et veniam\",\n \"logFieldPath\": \"qui sit reprehenderit\",\n \"ruleQueryName\": \"nisi aute\",\n \"tableName\": \"mollit Ut\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"voluptate aliqua anim aute\",\n \"logFieldPath\": \"qui Lorem\",\n \"ruleQueryName\": \"Excepteur voluptate adipisicing labore\",\n \"tableName\": \"in\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"incididunt dolor sit id tempor\",\n \"sunt aliquip cupidatat\"\n ],\n \"version\": 1\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"cases\": [\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"dolor commod\"\n },\n \"type\": \"block_user\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"nulla\"\n },\n \"type\": \"block_user\"\n }\n ],\n \"condition\": \"ut dolor incididunt fugiat\",\n \"customStatus\": \"critical\",\n \"name\": \"ullamco pariatur\",\n \"notifications\": [\n \"est in aliqua magna consequat\",\n \"aute fugiat consequat\"\n ],\n \"status\": \"critical\"\n },\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"Excepteur u\",\n \"cillum68\": {},\n \"eu4_\": {},\n \"mollit_a\": {}\n },\n \"type\": \"block_ip\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"ad adipisicing velit\"\n },\n \"type\": \"block_ip\"\n }\n ],\n \"condition\": \"sed eu\",\n \"customStatus\": \"critical\",\n \"name\": \"sed deserunt\",\n \"notifications\": [\n \"consequat id\",\n \"aliquip ad amet tempor\"\n ],\n \"status\": \"critical\"\n }\n ],\n \"complianceSignalOptions\": {\n \"defaultActivationStatus\": true,\n \"defaultGroupByFields\": [\n \"consequat elit dolore ullamco\",\n \"elit cupidatat aliquip id\"\n ],\n \"userActivationStatus\": true,\n \"userGroupByFields\": [\n \"consequat magna ex\",\n \"non fugiat ipsum\"\n ]\n },\n \"customMessage\": \"officia\",\n \"customName\": \"labore aute velit id\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"cillum sed velit\"\n },\n {\n \"action\": \"require\",\n \"query\": \"eu elit incididunt\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"isEnabled\": false,\n \"message\": \"dolor laboris in id\",\n \"name\": \"id ex nostrud dolore mollit\",\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\",\n \"aliqua_0\": {},\n \"voluptate6\": {}\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 0,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 43200,\n \"maxSignalDuration\": 10800,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"Excepteur dolore in in\",\n \"magna dolore laborum cupidatat nisi\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"proident Lorem\",\n \"quis consequat velit eu ad\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"in commodo quis enim\",\n \"consequat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"sunt id nostrud\"\n }\n },\n \"queries\": [\n {\n \"aggregation\": \"sum\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"esse aliquip aute ullamco\",\n \"exercita\"\n ],\n \"groupByFields\": [\n \"esse est Lorem\",\n \"elit sint\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"non cupidatat aliquip qui\",\n \"metrics\": [\n \"Ut\",\n \"ullamco minim elit\"\n ],\n \"name\": \"sit sed cillum cupidatat Lorem\",\n \"query\": \"a > 3\"\n },\n {\n \"aggregation\": \"event_count\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"dol\",\n \"nisi sunt Excepteur aute\"\n ],\n \"groupByFields\": [\n \"elit fugiat\",\n \"velit ipsum incididunt laboris\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"occaecat non quis\",\n \"metrics\": [\n \"nisi magna nostrud\",\n \"commodo culp\"\n ],\n \"name\": \"elit ullamco aliquip\",\n \"query\": \"a > 3\"\n }\n ],\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"minim et veniam\",\n \"logFieldPath\": \"qui sit reprehenderit\",\n \"ruleQueryName\": \"nisi aute\",\n \"tableName\": \"mollit Ut\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"voluptate aliqua anim aute\",\n \"logFieldPath\": \"qui Lorem\",\n \"ruleQueryName\": \"Excepteur voluptate adipisicing labore\",\n \"tableName\": \"in\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"incididunt dolor sit id tempor\",\n \"sunt aliquip cupidatat\"\n ],\n \"version\": 1\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"cases\": [\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"dolor commod\"\n },\n \"type\": \"block_user\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"nulla\"\n },\n \"type\": \"block_user\"\n }\n ],\n \"condition\": \"ut dolor incididunt fugiat\",\n \"customStatus\": \"critical\",\n \"name\": \"ullamco pariatur\",\n \"notifications\": [\n \"est in aliqua magna consequat\",\n \"aute fugiat consequat\"\n ],\n \"status\": \"critical\"\n },\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"Excepteur u\",\n \"cillum68\": {},\n \"eu4_\": {},\n \"mollit_a\": {}\n },\n \"type\": \"block_ip\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"ad adipisicing velit\"\n },\n \"type\": \"block_ip\"\n }\n ],\n \"condition\": \"sed eu\",\n \"customStatus\": \"critical\",\n \"name\": \"sed deserunt\",\n \"notifications\": [\n \"consequat id\",\n \"aliquip ad amet tempor\"\n ],\n \"status\": \"critical\"\n }\n ],\n \"complianceSignalOptions\": {\n \"defaultActivationStatus\": true,\n \"defaultGroupByFields\": [\n \"consequat elit dolore ullamco\",\n \"elit cupidatat aliquip id\"\n ],\n \"userActivationStatus\": true,\n \"userGroupByFields\": [\n \"consequat magna ex\",\n \"non fugiat ipsum\"\n ]\n },\n \"customMessage\": \"officia\",\n \"customName\": \"labore aute velit id\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"cillum sed velit\"\n },\n {\n \"action\": \"require\",\n \"query\": \"eu elit incididunt\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"isEnabled\": false,\n \"message\": \"dolor laboris in id\",\n \"name\": \"id ex nostrud dolore mollit\",\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\",\n \"aliqua_0\": {},\n \"voluptate6\": {}\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 0,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 43200,\n \"maxSignalDuration\": 10800,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"Excepteur dolore in in\",\n \"magna dolore laborum cupidatat nisi\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"proident Lorem\",\n \"quis consequat velit eu ad\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"in commodo quis enim\",\n \"consequat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"sunt id nostrud\"\n }\n },\n \"queries\": [\n {\n \"aggregation\": \"sum\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"esse aliquip aute ullamco\",\n \"exercita\"\n ],\n \"groupByFields\": [\n \"esse est Lorem\",\n \"elit sint\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"non cupidatat aliquip qui\",\n \"metrics\": [\n \"Ut\",\n \"ullamco minim elit\"\n ],\n \"name\": \"sit sed cillum cupidatat Lorem\",\n \"query\": \"a > 3\"\n },\n {\n \"aggregation\": \"event_count\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"dol\",\n \"nisi sunt Excepteur aute\"\n ],\n \"groupByFields\": [\n \"elit fugiat\",\n \"velit ipsum incididunt laboris\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"occaecat non quis\",\n \"metrics\": [\n \"nisi magna nostrud\",\n \"commodo culp\"\n ],\n \"name\": \"elit ullamco aliquip\",\n \"query\": \"a > 3\"\n }\n ],\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"minim et veniam\",\n \"logFieldPath\": \"qui sit reprehenderit\",\n \"ruleQueryName\": \"nisi aute\",\n \"tableName\": \"mollit Ut\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"voluptate aliqua anim aute\",\n \"logFieldPath\": \"qui Lorem\",\n \"ruleQueryName\": \"Excepteur voluptate adipisicing labore\",\n \"tableName\": \"in\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"incididunt dolor sit id tempor\",\n \"sunt aliquip cupidatat\"\n ],\n \"version\": 1\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"cases\": [\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"dolor commod\"\n },\n \"type\": \"block_user\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"nulla\"\n },\n \"type\": \"block_user\"\n }\n ],\n \"condition\": \"ut dolor incididunt fugiat\",\n \"customStatus\": \"critical\",\n \"name\": \"ullamco pariatur\",\n \"notifications\": [\n \"est in aliqua magna consequat\",\n \"aute fugiat consequat\"\n ],\n \"status\": \"critical\"\n },\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"Excepteur u\",\n \"cillum68\": {},\n \"eu4_\": {},\n \"mollit_a\": {}\n },\n \"type\": \"block_ip\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"ad adipisicing velit\"\n },\n \"type\": \"block_ip\"\n }\n ],\n \"condition\": \"sed eu\",\n \"customStatus\": \"critical\",\n \"name\": \"sed deserunt\",\n \"notifications\": [\n \"consequat id\",\n \"aliquip ad amet tempor\"\n ],\n \"status\": \"critical\"\n }\n ],\n \"complianceSignalOptions\": {\n \"defaultActivationStatus\": true,\n \"defaultGroupByFields\": [\n \"consequat elit dolore ullamco\",\n \"elit cupidatat aliquip id\"\n ],\n \"userActivationStatus\": true,\n \"userGroupByFields\": [\n \"consequat magna ex\",\n \"non fugiat ipsum\"\n ]\n },\n \"customMessage\": \"officia\",\n \"customName\": \"labore aute velit id\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"cillum sed velit\"\n },\n {\n \"action\": \"require\",\n \"query\": \"eu elit incididunt\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"isEnabled\": false,\n \"message\": \"dolor laboris in id\",\n \"name\": \"id ex nostrud dolore mollit\",\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\",\n \"aliqua_0\": {},\n \"voluptate6\": {}\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 0,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 43200,\n \"maxSignalDuration\": 10800,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"Excepteur dolore in in\",\n \"magna dolore laborum cupidatat nisi\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"proident Lorem\",\n \"quis consequat velit eu ad\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"in commodo quis enim\",\n \"consequat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"sunt id nostrud\"\n }\n },\n \"queries\": [\n {\n \"aggregation\": \"sum\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"esse aliquip aute ullamco\",\n \"exercita\"\n ],\n \"groupByFields\": [\n \"esse est Lorem\",\n \"elit sint\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"non cupidatat aliquip qui\",\n \"metrics\": [\n \"Ut\",\n \"ullamco minim elit\"\n ],\n \"name\": \"sit sed cillum cupidatat Lorem\",\n \"query\": \"a > 3\"\n },\n {\n \"aggregation\": \"event_count\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"dol\",\n \"nisi sunt Excepteur aute\"\n ],\n \"groupByFields\": [\n \"elit fugiat\",\n \"velit ipsum incididunt laboris\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"occaecat non quis\",\n \"metrics\": [\n \"nisi magna nostrud\",\n \"commodo culp\"\n ],\n \"name\": \"elit ullamco aliquip\",\n \"query\": \"a > 3\"\n }\n ],\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"minim et veniam\",\n \"logFieldPath\": \"qui sit reprehenderit\",\n \"ruleQueryName\": \"nisi aute\",\n \"tableName\": \"mollit Ut\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"voluptate aliqua anim aute\",\n \"logFieldPath\": \"qui Lorem\",\n \"ruleQueryName\": \"Excepteur voluptate adipisicing labore\",\n \"tableName\": \"in\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"incididunt dolor sit id tempor\",\n \"sunt aliquip cupidatat\"\n ],\n \"version\": 1\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"cases\": [\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"dolor commod\"\n },\n \"type\": \"block_user\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"nulla\"\n },\n \"type\": \"block_user\"\n }\n ],\n \"condition\": \"ut dolor incididunt fugiat\",\n \"customStatus\": \"critical\",\n \"name\": \"ullamco pariatur\",\n \"notifications\": [\n \"est in aliqua magna consequat\",\n \"aute fugiat consequat\"\n ],\n \"status\": \"critical\"\n },\n {\n \"actions\": [\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"Excepteur u\",\n \"cillum68\": {},\n \"eu4_\": {},\n \"mollit_a\": {}\n },\n \"type\": \"block_ip\"\n },\n {\n \"options\": {\n \"duration\": 0,\n \"flaggedIPType\": \"FLAGGED\",\n \"userBehaviorName\": \"ad adipisicing velit\"\n },\n \"type\": \"block_ip\"\n }\n ],\n \"condition\": \"sed eu\",\n \"customStatus\": \"critical\",\n \"name\": \"sed deserunt\",\n \"notifications\": [\n \"consequat id\",\n \"aliquip ad amet tempor\"\n ],\n \"status\": \"critical\"\n }\n ],\n \"complianceSignalOptions\": {\n \"defaultActivationStatus\": true,\n \"defaultGroupByFields\": [\n \"consequat elit dolore ullamco\",\n \"elit cupidatat aliquip id\"\n ],\n \"userActivationStatus\": true,\n \"userGroupByFields\": [\n \"consequat magna ex\",\n \"non fugiat ipsum\"\n ]\n },\n \"customMessage\": \"officia\",\n \"customName\": \"labore aute velit id\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"cillum sed velit\"\n },\n {\n \"action\": \"require\",\n \"query\": \"eu elit incididunt\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"isEnabled\": false,\n \"message\": \"dolor laboris in id\",\n \"name\": \"id ex nostrud dolore mollit\",\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\",\n \"aliqua_0\": {},\n \"voluptate6\": {}\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"anomaly_threshold\",\n \"evaluationWindow\": 0,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 43200,\n \"maxSignalDuration\": 10800,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"Excepteur dolore in in\",\n \"magna dolore laborum cupidatat nisi\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"proident Lorem\",\n \"quis consequat velit eu ad\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"in commodo quis enim\",\n \"consequat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"sunt id nostrud\"\n }\n },\n \"queries\": [\n {\n \"aggregation\": \"sum\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"esse aliquip aute ullamco\",\n \"exercita\"\n ],\n \"groupByFields\": [\n \"esse est Lorem\",\n \"elit sint\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"non cupidatat aliquip qui\",\n \"metrics\": [\n \"Ut\",\n \"ullamco minim elit\"\n ],\n \"name\": \"sit sed cillum cupidatat Lorem\",\n \"query\": \"a > 3\"\n },\n {\n \"aggregation\": \"event_count\",\n \"customQueryExtension\": \"a > 3\",\n \"dataSource\": \"logs\",\n \"distinctFields\": [\n \"dol\",\n \"nisi sunt Excepteur aute\"\n ],\n \"groupByFields\": [\n \"elit fugiat\",\n \"velit ipsum incididunt laboris\"\n ],\n \"hasOptionalGroupByFields\": false,\n \"index\": \"occaecat non quis\",\n \"metrics\": [\n \"nisi magna nostrud\",\n \"commodo culp\"\n ],\n \"name\": \"elit ullamco aliquip\",\n \"query\": \"a > 3\"\n }\n ],\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"minim et veniam\",\n \"logFieldPath\": \"qui sit reprehenderit\",\n \"ruleQueryName\": \"nisi aute\",\n \"tableName\": \"mollit Ut\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"voluptate aliqua anim aute\",\n \"logFieldPath\": \"qui Lorem\",\n \"ruleQueryName\": \"Excepteur voluptate adipisicing labore\",\n \"tableName\": \"in\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"incididunt dolor sit id tempor\",\n \"sunt aliquip cupidatat\"\n ],\n \"version\": 1\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete an existing rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Delete an existing rule. Default rules cannot be deleted."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Test an existing rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"rule\": {\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"new_value\",\n \"evaluationWindow\": 60,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 900,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"occaecat dolore\",\n \"non culpa adipisicing\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"sit Duis deserunt ut adipisicing\",\n \"in dolore sit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"ipsum amet\",\n \"non id fugiat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"elit fugiat\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"reprehenderit consectetur ad\"\n },\n {\n \"action\": \"require\",\n \"query\": \"ullamco nisi\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"reprehenderit et culpa\",\n \"logFieldPath\": \"aliqua enim\",\n \"ruleQueryName\": \"aute nulla\",\n \"tableName\": \"eu dolore dolor\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ad nostrud consectetur dolor\",\n \"logFieldPath\": \"nostrud no\",\n \"ruleQueryName\": \"ut ea\",\n \"tableName\": \"do enim reprehenderit\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"log_detection\"\n },\n \"ruleQueryPayloads\": [\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n },\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id/test",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id",
"test"
],
"variable": [
{
"key": "rule_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Test an existing rule."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"rule\": {\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"new_value\",\n \"evaluationWindow\": 60,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 900,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"occaecat dolore\",\n \"non culpa adipisicing\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"sit Duis deserunt ut adipisicing\",\n \"in dolore sit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"ipsum amet\",\n \"non id fugiat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"elit fugiat\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"reprehenderit consectetur ad\"\n },\n {\n \"action\": \"require\",\n \"query\": \"ullamco nisi\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"reprehenderit et culpa\",\n \"logFieldPath\": \"aliqua enim\",\n \"ruleQueryName\": \"aute nulla\",\n \"tableName\": \"eu dolore dolor\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ad nostrud consectetur dolor\",\n \"logFieldPath\": \"nostrud no\",\n \"ruleQueryName\": \"ut ea\",\n \"tableName\": \"do enim reprehenderit\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"log_detection\"\n },\n \"ruleQueryPayloads\": [\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n },\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id/test",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id",
"test"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"results\": [\n false,\n false\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"rule\": {\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"new_value\",\n \"evaluationWindow\": 60,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 900,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"occaecat dolore\",\n \"non culpa adipisicing\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"sit Duis deserunt ut adipisicing\",\n \"in dolore sit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"ipsum amet\",\n \"non id fugiat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"elit fugiat\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"reprehenderit consectetur ad\"\n },\n {\n \"action\": \"require\",\n \"query\": \"ullamco nisi\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"reprehenderit et culpa\",\n \"logFieldPath\": \"aliqua enim\",\n \"ruleQueryName\": \"aute nulla\",\n \"tableName\": \"eu dolore dolor\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ad nostrud consectetur dolor\",\n \"logFieldPath\": \"nostrud no\",\n \"ruleQueryName\": \"ut ea\",\n \"tableName\": \"do enim reprehenderit\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"log_detection\"\n },\n \"ruleQueryPayloads\": [\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n },\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id/test",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id",
"test"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"rule\": {\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"new_value\",\n \"evaluationWindow\": 60,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 900,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"occaecat dolore\",\n \"non culpa adipisicing\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"sit Duis deserunt ut adipisicing\",\n \"in dolore sit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"ipsum amet\",\n \"non id fugiat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"elit fugiat\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"reprehenderit consectetur ad\"\n },\n {\n \"action\": \"require\",\n \"query\": \"ullamco nisi\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"reprehenderit et culpa\",\n \"logFieldPath\": \"aliqua enim\",\n \"ruleQueryName\": \"aute nulla\",\n \"tableName\": \"eu dolore dolor\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ad nostrud consectetur dolor\",\n \"logFieldPath\": \"nostrud no\",\n \"ruleQueryName\": \"ut ea\",\n \"tableName\": \"do enim reprehenderit\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"log_detection\"\n },\n \"ruleQueryPayloads\": [\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n },\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id/test",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id",
"test"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"rule\": {\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"new_value\",\n \"evaluationWindow\": 60,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 900,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"occaecat dolore\",\n \"non culpa adipisicing\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"sit Duis deserunt ut adipisicing\",\n \"in dolore sit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"ipsum amet\",\n \"non id fugiat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"elit fugiat\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"reprehenderit consectetur ad\"\n },\n {\n \"action\": \"require\",\n \"query\": \"ullamco nisi\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"reprehenderit et culpa\",\n \"logFieldPath\": \"aliqua enim\",\n \"ruleQueryName\": \"aute nulla\",\n \"tableName\": \"eu dolore dolor\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ad nostrud consectetur dolor\",\n \"logFieldPath\": \"nostrud no\",\n \"ruleQueryName\": \"ut ea\",\n \"tableName\": \"do enim reprehenderit\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"log_detection\"\n },\n \"ruleQueryPayloads\": [\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n },\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id/test",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id",
"test"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"rule\": {\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"new_value\",\n \"evaluationWindow\": 60,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 900,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"occaecat dolore\",\n \"non culpa adipisicing\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"sit Duis deserunt ut adipisicing\",\n \"in dolore sit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"ipsum amet\",\n \"non id fugiat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"elit fugiat\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"reprehenderit consectetur ad\"\n },\n {\n \"action\": \"require\",\n \"query\": \"ullamco nisi\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"reprehenderit et culpa\",\n \"logFieldPath\": \"aliqua enim\",\n \"ruleQueryName\": \"aute nulla\",\n \"tableName\": \"eu dolore dolor\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ad nostrud consectetur dolor\",\n \"logFieldPath\": \"nostrud no\",\n \"ruleQueryName\": \"ut ea\",\n \"tableName\": \"do enim reprehenderit\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"log_detection\"\n },\n \"ruleQueryPayloads\": [\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n },\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id/test",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id",
"test"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"rule\": {\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"new_value\",\n \"evaluationWindow\": 60,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 900,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"occaecat dolore\",\n \"non culpa adipisicing\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"sit Duis deserunt ut adipisicing\",\n \"in dolore sit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"ipsum amet\",\n \"non id fugiat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"elit fugiat\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"reprehenderit consectetur ad\"\n },\n {\n \"action\": \"require\",\n \"query\": \"ullamco nisi\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"reprehenderit et culpa\",\n \"logFieldPath\": \"aliqua enim\",\n \"ruleQueryName\": \"aute nulla\",\n \"tableName\": \"eu dolore dolor\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ad nostrud consectetur dolor\",\n \"logFieldPath\": \"nostrud no\",\n \"ruleQueryName\": \"ut ea\",\n \"tableName\": \"do enim reprehenderit\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"log_detection\"\n },\n \"ruleQueryPayloads\": [\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n },\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id/test",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id",
"test"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Test a rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"rule\": {\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"new_value\",\n \"evaluationWindow\": 60,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 900,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"occaecat dolore\",\n \"non culpa adipisicing\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"sit Duis deserunt ut adipisicing\",\n \"in dolore sit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"ipsum amet\",\n \"non id fugiat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"elit fugiat\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"reprehenderit consectetur ad\"\n },\n {\n \"action\": \"require\",\n \"query\": \"ullamco nisi\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"reprehenderit et culpa\",\n \"logFieldPath\": \"aliqua enim\",\n \"ruleQueryName\": \"aute nulla\",\n \"tableName\": \"eu dolore dolor\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ad nostrud consectetur dolor\",\n \"logFieldPath\": \"nostrud no\",\n \"ruleQueryName\": \"ut ea\",\n \"tableName\": \"do enim reprehenderit\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"log_detection\"\n },\n \"ruleQueryPayloads\": [\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n },\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/test",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"test"
]
},
"description": "Test a rule."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"rule\": {\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"new_value\",\n \"evaluationWindow\": 60,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 900,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"occaecat dolore\",\n \"non culpa adipisicing\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"sit Duis deserunt ut adipisicing\",\n \"in dolore sit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"ipsum amet\",\n \"non id fugiat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"elit fugiat\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"reprehenderit consectetur ad\"\n },\n {\n \"action\": \"require\",\n \"query\": \"ullamco nisi\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"reprehenderit et culpa\",\n \"logFieldPath\": \"aliqua enim\",\n \"ruleQueryName\": \"aute nulla\",\n \"tableName\": \"eu dolore dolor\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ad nostrud consectetur dolor\",\n \"logFieldPath\": \"nostrud no\",\n \"ruleQueryName\": \"ut ea\",\n \"tableName\": \"do enim reprehenderit\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"log_detection\"\n },\n \"ruleQueryPayloads\": [\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n },\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/test",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"test"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"results\": [\n false,\n false\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"rule\": {\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"new_value\",\n \"evaluationWindow\": 60,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 900,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"occaecat dolore\",\n \"non culpa adipisicing\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"sit Duis deserunt ut adipisicing\",\n \"in dolore sit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"ipsum amet\",\n \"non id fugiat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"elit fugiat\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"reprehenderit consectetur ad\"\n },\n {\n \"action\": \"require\",\n \"query\": \"ullamco nisi\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"reprehenderit et culpa\",\n \"logFieldPath\": \"aliqua enim\",\n \"ruleQueryName\": \"aute nulla\",\n \"tableName\": \"eu dolore dolor\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ad nostrud consectetur dolor\",\n \"logFieldPath\": \"nostrud no\",\n \"ruleQueryName\": \"ut ea\",\n \"tableName\": \"do enim reprehenderit\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"log_detection\"\n },\n \"ruleQueryPayloads\": [\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n },\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/test",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"test"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"rule\": {\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"new_value\",\n \"evaluationWindow\": 60,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 900,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"occaecat dolore\",\n \"non culpa adipisicing\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"sit Duis deserunt ut adipisicing\",\n \"in dolore sit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"ipsum amet\",\n \"non id fugiat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"elit fugiat\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"reprehenderit consectetur ad\"\n },\n {\n \"action\": \"require\",\n \"query\": \"ullamco nisi\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"reprehenderit et culpa\",\n \"logFieldPath\": \"aliqua enim\",\n \"ruleQueryName\": \"aute nulla\",\n \"tableName\": \"eu dolore dolor\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ad nostrud consectetur dolor\",\n \"logFieldPath\": \"nostrud no\",\n \"ruleQueryName\": \"ut ea\",\n \"tableName\": \"do enim reprehenderit\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"log_detection\"\n },\n \"ruleQueryPayloads\": [\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n },\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/test",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"test"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"rule\": {\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"new_value\",\n \"evaluationWindow\": 60,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 900,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"occaecat dolore\",\n \"non culpa adipisicing\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"sit Duis deserunt ut adipisicing\",\n \"in dolore sit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"ipsum amet\",\n \"non id fugiat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"elit fugiat\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"reprehenderit consectetur ad\"\n },\n {\n \"action\": \"require\",\n \"query\": \"ullamco nisi\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"reprehenderit et culpa\",\n \"logFieldPath\": \"aliqua enim\",\n \"ruleQueryName\": \"aute nulla\",\n \"tableName\": \"eu dolore dolor\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ad nostrud consectetur dolor\",\n \"logFieldPath\": \"nostrud no\",\n \"ruleQueryName\": \"ut ea\",\n \"tableName\": \"do enim reprehenderit\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"log_detection\"\n },\n \"ruleQueryPayloads\": [\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n },\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/test",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"test"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"rule\": {\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"new_value\",\n \"evaluationWindow\": 60,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 900,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"occaecat dolore\",\n \"non culpa adipisicing\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"sit Duis deserunt ut adipisicing\",\n \"in dolore sit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"ipsum amet\",\n \"non id fugiat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"elit fugiat\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"reprehenderit consectetur ad\"\n },\n {\n \"action\": \"require\",\n \"query\": \"ullamco nisi\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"reprehenderit et culpa\",\n \"logFieldPath\": \"aliqua enim\",\n \"ruleQueryName\": \"aute nulla\",\n \"tableName\": \"eu dolore dolor\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ad nostrud consectetur dolor\",\n \"logFieldPath\": \"nostrud no\",\n \"ruleQueryName\": \"ut ea\",\n \"tableName\": \"do enim reprehenderit\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"log_detection\"\n },\n \"ruleQueryPayloads\": [\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n },\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/test",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"test"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"rule\": {\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"new_value\",\n \"evaluationWindow\": 60,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 900,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"occaecat dolore\",\n \"non culpa adipisicing\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"sit Duis deserunt ut adipisicing\",\n \"in dolore sit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"ipsum amet\",\n \"non id fugiat\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"elit fugiat\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"filters\": [\n {\n \"action\": \"require\",\n \"query\": \"reprehenderit consectetur ad\"\n },\n {\n \"action\": \"require\",\n \"query\": \"ullamco nisi\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": false,\n \"columnName\": \"reprehenderit et culpa\",\n \"logFieldPath\": \"aliqua enim\",\n \"ruleQueryName\": \"aute nulla\",\n \"tableName\": \"eu dolore dolor\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ad nostrud consectetur dolor\",\n \"logFieldPath\": \"nostrud no\",\n \"ruleQueryName\": \"ut ea\",\n \"tableName\": \"do enim reprehenderit\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"log_detection\"\n },\n \"ruleQueryPayloads\": [\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n },\n {\n \"expectedResult\": true,\n \"index\": 0,\n \"payload\": {\n \"ddsource\": \"nginx\",\n \"ddtags\": \"env:staging,version:5.1\",\n \"hostname\": \"i-012345678\",\n \"message\": \"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\",\n \"service\": \"payment\"\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/test",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"test"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Validate a detection rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"impossible_travel\",\n \"evaluationWindow\": 10800,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 10800,\n \"maxSignalDuration\": 43200,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"in fugiat proident dolore\",\n \"deserunt non\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"quis magna id\",\n \"Duis reprehenderit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"sunt eiusmod elit dolore\",\n \"id\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"mollit quis adipisicing dolor deserunt\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"customMessage\": \"sit id enim officia\",\n \"customName\": \"esse Lorem minim\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"sunt dolore cupidatat aute ea\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"officia Excepteur nostrud\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"Lorem adipisicing anim\",\n \"logFieldPath\": \"Duis anim\",\n \"ruleQueryName\": \"veniam\",\n \"tableName\": \"adipisicing voluptate magna laborum\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ex labo\",\n \"logFieldPath\": \"reprehenderit nulla\",\n \"ruleQueryName\": \"aliquip\",\n \"tableName\": \"commodo culpa minim\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"application_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/validation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"validation"
]
},
"description": "Validate a detection rule."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"impossible_travel\",\n \"evaluationWindow\": 10800,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 10800,\n \"maxSignalDuration\": 43200,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"in fugiat proident dolore\",\n \"deserunt non\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"quis magna id\",\n \"Duis reprehenderit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"sunt eiusmod elit dolore\",\n \"id\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"mollit quis adipisicing dolor deserunt\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"customMessage\": \"sit id enim officia\",\n \"customName\": \"esse Lorem minim\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"sunt dolore cupidatat aute ea\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"officia Excepteur nostrud\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"Lorem adipisicing anim\",\n \"logFieldPath\": \"Duis anim\",\n \"ruleQueryName\": \"veniam\",\n \"tableName\": \"adipisicing voluptate magna laborum\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ex labo\",\n \"logFieldPath\": \"reprehenderit nulla\",\n \"ruleQueryName\": \"aliquip\",\n \"tableName\": \"commodo culpa minim\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"application_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/validation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"validation"
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"impossible_travel\",\n \"evaluationWindow\": 10800,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 10800,\n \"maxSignalDuration\": 43200,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"in fugiat proident dolore\",\n \"deserunt non\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"quis magna id\",\n \"Duis reprehenderit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"sunt eiusmod elit dolore\",\n \"id\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"mollit quis adipisicing dolor deserunt\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"customMessage\": \"sit id enim officia\",\n \"customName\": \"esse Lorem minim\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"sunt dolore cupidatat aute ea\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"officia Excepteur nostrud\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"Lorem adipisicing anim\",\n \"logFieldPath\": \"Duis anim\",\n \"ruleQueryName\": \"veniam\",\n \"tableName\": \"adipisicing voluptate magna laborum\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ex labo\",\n \"logFieldPath\": \"reprehenderit nulla\",\n \"ruleQueryName\": \"aliquip\",\n \"tableName\": \"commodo culpa minim\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"application_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/validation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"validation"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"impossible_travel\",\n \"evaluationWindow\": 10800,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 10800,\n \"maxSignalDuration\": 43200,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"in fugiat proident dolore\",\n \"deserunt non\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"quis magna id\",\n \"Duis reprehenderit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"sunt eiusmod elit dolore\",\n \"id\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"mollit quis adipisicing dolor deserunt\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"customMessage\": \"sit id enim officia\",\n \"customName\": \"esse Lorem minim\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"sunt dolore cupidatat aute ea\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"officia Excepteur nostrud\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"Lorem adipisicing anim\",\n \"logFieldPath\": \"Duis anim\",\n \"ruleQueryName\": \"veniam\",\n \"tableName\": \"adipisicing voluptate magna laborum\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ex labo\",\n \"logFieldPath\": \"reprehenderit nulla\",\n \"ruleQueryName\": \"aliquip\",\n \"tableName\": \"commodo culpa minim\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"application_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/validation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"validation"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"impossible_travel\",\n \"evaluationWindow\": 10800,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 10800,\n \"maxSignalDuration\": 43200,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"in fugiat proident dolore\",\n \"deserunt non\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"quis magna id\",\n \"Duis reprehenderit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"sunt eiusmod elit dolore\",\n \"id\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"mollit quis adipisicing dolor deserunt\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"customMessage\": \"sit id enim officia\",\n \"customName\": \"esse Lorem minim\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"sunt dolore cupidatat aute ea\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"officia Excepteur nostrud\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"Lorem adipisicing anim\",\n \"logFieldPath\": \"Duis anim\",\n \"ruleQueryName\": \"veniam\",\n \"tableName\": \"adipisicing voluptate magna laborum\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ex labo\",\n \"logFieldPath\": \"reprehenderit nulla\",\n \"ruleQueryName\": \"aliquip\",\n \"tableName\": \"commodo culpa minim\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"application_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/validation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"validation"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Change the related incidents of a security signal",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"incident_ids\": [\n 2066\n ],\n \"version\": -28051461\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/incidents",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"incidents"
],
"variable": [
{
"key": "signal_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Change the related incidents for a security signal."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"incident_ids\": [\n 2066\n ],\n \"version\": -28051461\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/incidents",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"incidents"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"assignee\": {\n \"uuid\": \"773b045d-ccf8-4808-bd3b-955ef6a8c940\",\n \"handle\": \"aliqua cupidatat cillum commodo\",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"id\": 47208238,\n \"name\": \"nulla sed sit officia a\"\n },\n \"state\": \"open\",\n \"incident_ids\": [\n 2066\n ],\n \"archive_comment\": \"deserunt fugiat aute dolor\",\n \"archive_comment_timestamp\": 81712675,\n \"archive_comment_user\": {\n \"uuid\": \"773b045d-ccf8-4808-bd3b-955ef6a8c940\",\n \"handle\": \"ad Except\",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"id\": -54134050,\n \"name\": \"ea Lorem veniam\"\n },\n \"archive_reason\": \"investigated_case_opened\",\n \"state_update_timestamp\": 65728848,\n \"state_update_user\": {\n \"uuid\": \"773b045d-ccf8-4808-bd3b-955ef6a8c940\",\n \"handle\": \"proident \",\n \"icon\": \"/path/to/matching/gravatar/icon\",\n \"id\": 6700913,\n \"name\": \"magna in\"\n }\n },\n \"id\": \"non occaecat tempor in id\",\n \"type\": \"signal_metadata\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"incident_ids\": [\n 2066\n ],\n \"version\": -28051461\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/incidents",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"incidents"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"incident_ids\": [\n 2066\n ],\n \"version\": -28051461\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/incidents",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"incidents"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"incident_ids\": [\n 2066\n ],\n \"version\": -28051461\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/incidents",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"incidents"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"incident_ids\": [\n 2066\n ],\n \"version\": -28051461\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/incidents",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"incidents"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Convert an existing rule from JSON to Terraform",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id/convert",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id",
"convert"
],
"variable": [
{
"key": "rule_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Convert an existing rule from JSON to Terraform for datadog provider\nresource datadog_security_monitoring_rule."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id/convert",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id",
"convert"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"terraformContent\": \"ea amet in consequat \"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id/convert",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id",
"convert"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id/convert",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id",
"convert"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id/convert",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id",
"convert"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id/convert",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
":rule_id",
"convert"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Convert a rule from JSON to Terraform",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"impossible_travel\",\n \"evaluationWindow\": 10800,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 10800,\n \"maxSignalDuration\": 43200,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"in fugiat proident dolore\",\n \"deserunt non\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"quis magna id\",\n \"Duis reprehenderit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"sunt eiusmod elit dolore\",\n \"id\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"mollit quis adipisicing dolor deserunt\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"customMessage\": \"sit id enim officia\",\n \"customName\": \"esse Lorem minim\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"sunt dolore cupidatat aute ea\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"officia Excepteur nostrud\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"Lorem adipisicing anim\",\n \"logFieldPath\": \"Duis anim\",\n \"ruleQueryName\": \"veniam\",\n \"tableName\": \"adipisicing voluptate magna laborum\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ex labo\",\n \"logFieldPath\": \"reprehenderit nulla\",\n \"ruleQueryName\": \"aliquip\",\n \"tableName\": \"commodo culpa minim\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"application_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/convert",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"convert"
]
},
"description": "Convert a rule that doesn't (yet) exist from JSON to Terraform for datadog provider\nresource datadog_security_monitoring_rule."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"impossible_travel\",\n \"evaluationWindow\": 10800,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 10800,\n \"maxSignalDuration\": 43200,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"in fugiat proident dolore\",\n \"deserunt non\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"quis magna id\",\n \"Duis reprehenderit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"sunt eiusmod elit dolore\",\n \"id\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"mollit quis adipisicing dolor deserunt\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"customMessage\": \"sit id enim officia\",\n \"customName\": \"esse Lorem minim\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"sunt dolore cupidatat aute ea\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"officia Excepteur nostrud\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"Lorem adipisicing anim\",\n \"logFieldPath\": \"Duis anim\",\n \"ruleQueryName\": \"veniam\",\n \"tableName\": \"adipisicing voluptate magna laborum\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ex labo\",\n \"logFieldPath\": \"reprehenderit nulla\",\n \"ruleQueryName\": \"aliquip\",\n \"tableName\": \"commodo culpa minim\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"application_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/convert",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"convert"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"terraformContent\": \"ea amet in consequat \"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"impossible_travel\",\n \"evaluationWindow\": 10800,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 10800,\n \"maxSignalDuration\": 43200,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"in fugiat proident dolore\",\n \"deserunt non\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"quis magna id\",\n \"Duis reprehenderit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"sunt eiusmod elit dolore\",\n \"id\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"mollit quis adipisicing dolor deserunt\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"customMessage\": \"sit id enim officia\",\n \"customName\": \"esse Lorem minim\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"sunt dolore cupidatat aute ea\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"officia Excepteur nostrud\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"Lorem adipisicing anim\",\n \"logFieldPath\": \"Duis anim\",\n \"ruleQueryName\": \"veniam\",\n \"tableName\": \"adipisicing voluptate magna laborum\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ex labo\",\n \"logFieldPath\": \"reprehenderit nulla\",\n \"ruleQueryName\": \"aliquip\",\n \"tableName\": \"commodo culpa minim\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"application_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/convert",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"convert"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"impossible_travel\",\n \"evaluationWindow\": 10800,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 10800,\n \"maxSignalDuration\": 43200,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"in fugiat proident dolore\",\n \"deserunt non\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"quis magna id\",\n \"Duis reprehenderit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"sunt eiusmod elit dolore\",\n \"id\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"mollit quis adipisicing dolor deserunt\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"customMessage\": \"sit id enim officia\",\n \"customName\": \"esse Lorem minim\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"sunt dolore cupidatat aute ea\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"officia Excepteur nostrud\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"Lorem adipisicing anim\",\n \"logFieldPath\": \"Duis anim\",\n \"ruleQueryName\": \"veniam\",\n \"tableName\": \"adipisicing voluptate magna laborum\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ex labo\",\n \"logFieldPath\": \"reprehenderit nulla\",\n \"ruleQueryName\": \"aliquip\",\n \"tableName\": \"commodo culpa minim\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"application_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/convert",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"convert"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"impossible_travel\",\n \"evaluationWindow\": 10800,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 10800,\n \"maxSignalDuration\": 43200,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"in fugiat proident dolore\",\n \"deserunt non\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"quis magna id\",\n \"Duis reprehenderit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"sunt eiusmod elit dolore\",\n \"id\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"mollit quis adipisicing dolor deserunt\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"customMessage\": \"sit id enim officia\",\n \"customName\": \"esse Lorem minim\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"sunt dolore cupidatat aute ea\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"officia Excepteur nostrud\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"Lorem adipisicing anim\",\n \"logFieldPath\": \"Duis anim\",\n \"ruleQueryName\": \"veniam\",\n \"tableName\": \"adipisicing voluptate magna laborum\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ex labo\",\n \"logFieldPath\": \"reprehenderit nulla\",\n \"ruleQueryName\": \"aliquip\",\n \"tableName\": \"commodo culpa minim\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"application_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/convert",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"convert"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"impossible_travel\",\n \"evaluationWindow\": 10800,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 10800,\n \"maxSignalDuration\": 43200,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"in fugiat proident dolore\",\n \"deserunt non\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"quis magna id\",\n \"Duis reprehenderit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"sunt eiusmod elit dolore\",\n \"id\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"mollit quis adipisicing dolor deserunt\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"customMessage\": \"sit id enim officia\",\n \"customName\": \"esse Lorem minim\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"sunt dolore cupidatat aute ea\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"officia Excepteur nostrud\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"Lorem adipisicing anim\",\n \"logFieldPath\": \"Duis anim\",\n \"ruleQueryName\": \"veniam\",\n \"tableName\": \"adipisicing voluptate magna laborum\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ex labo\",\n \"logFieldPath\": \"reprehenderit nulla\",\n \"ruleQueryName\": \"aliquip\",\n \"tableName\": \"commodo culpa minim\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"application_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/convert",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"convert"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"My security monitoring rule.\",\n \"isEnabled\": true,\n \"queries\": [],\n \"options\": {\n \"complianceRuleOptions\": {\n \"complexRule\": false,\n \"regoRule\": {\n \"policy\": \"package datadog\\n\\nimport data.datadog.output as dd_output\\nimport future.keywords.contains\\nimport future.keywords.if\\nimport future.keywords.in\\n\\neval(resource) = \\\"skip\\\" if {\\n # Logic that evaluates to true if the resource should be skipped\\n true\\n} else = \\\"pass\\\" {\\n # Logic that evaluates to true if the resource is compliant\\n true\\n} else = \\\"fail\\\" {\\n # Logic that evaluates to true if the resource is not compliant\\n true\\n}\\n\\n# This part remains unchanged for all rules\\nresults contains result if {\\n some resource in input.resources[input.main_resource_type]\\n result := dd_output.format(resource, eval(resource))\\n}\\n\",\n \"resourceTypes\": [\n \"gcp_iam_service_account\",\n \"gcp_iam_policy\"\n ]\n },\n \"resourceType\": \"aws_acm\"\n },\n \"decreaseCriticalityBasedOnEnv\": false,\n \"detectionMethod\": \"impossible_travel\",\n \"evaluationWindow\": 10800,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": true\n },\n \"keepAlive\": 10800,\n \"maxSignalDuration\": 43200,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n },\n \"thirdPartyRuleOptions\": {\n \"defaultNotifications\": [\n \"in fugiat proident dolore\",\n \"deserunt non\"\n ],\n \"defaultStatus\": \"critical\",\n \"rootQueries\": [\n {\n \"groupByFields\": [\n \"quis magna id\",\n \"Duis reprehenderit\"\n ],\n \"query\": \"source:cloudtrail\"\n },\n {\n \"groupByFields\": [\n \"sunt eiusmod elit dolore\",\n \"id\"\n ],\n \"query\": \"source:cloudtrail\"\n }\n ],\n \"signalTitleTemplate\": \"mollit quis adipisicing dolor deserunt\"\n }\n },\n \"cases\": [],\n \"message\": \"\",\n \"calculatedFields\": [\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n },\n {\n \"name\": \"response_time\",\n \"expression\": \"@request_end_timestamp - @request_start_timestamp\"\n }\n ],\n \"customMessage\": \"sit id enim officia\",\n \"customName\": \"esse Lorem minim\",\n \"filters\": [\n {\n \"action\": \"suppress\",\n \"query\": \"sunt dolore cupidatat aute ea\"\n },\n {\n \"action\": \"suppress\",\n \"query\": \"officia Excepteur nostrud\"\n }\n ],\n \"groupSignalsBy\": [\n \"service\"\n ],\n \"hasExtendedTitle\": true,\n \"referenceTables\": [\n {\n \"checkPresence\": true,\n \"columnName\": \"Lorem adipisicing anim\",\n \"logFieldPath\": \"Duis anim\",\n \"ruleQueryName\": \"veniam\",\n \"tableName\": \"adipisicing voluptate magna laborum\"\n },\n {\n \"checkPresence\": true,\n \"columnName\": \"ex labo\",\n \"logFieldPath\": \"reprehenderit nulla\",\n \"ruleQueryName\": \"aliquip\",\n \"tableName\": \"commodo culpa minim\"\n }\n ],\n \"schedulingOptions\": {\n \"rrule\": \"FREQ=HOURLY;INTERVAL=1;\",\n \"start\": \"2025-07-14T12:00:00\",\n \"timezone\": \"America/New_York\"\n },\n \"tags\": [\n \"env:prod\",\n \"team:security\"\n ],\n \"type\": \"application_security\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules/convert",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules",
"convert"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a list of security signals",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"2019-01-02T09:42:36.320Z\",\n \"query\": \"security:attack status:high\",\n \"to\": \"2019-01-03T09:42:36.320Z\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
"search"
]
},
"description": "Returns security signals that match a search query.\nBoth this endpoint and the GET endpoint can be used interchangeably for listing\nsecurity signals."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"2019-01-02T09:42:36.320Z\",\n \"query\": \"security:attack status:high\",\n \"to\": \"2019-01-03T09:42:36.320Z\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
"search"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"custom\": {\n \"workflow\": {\n \"first_seen\": \"2020-06-23T14:46:01.000Z\",\n \"last_seen\": \"2020-06-23T14:46:49.000Z\",\n \"rule\": {\n \"name\": \"Brute Force Attack Grouped By User \",\n \"version\": 12\n }\n }\n },\n \"message\": \"Detect Account Take Over (ATO) through brute force attempts\",\n \"tags\": [\n \"security:attack\",\n \"technique:T1110-brute-force\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"signal\"\n },\n {\n \"attributes\": {\n \"custom\": {\n \"workflow\": {\n \"first_seen\": \"2020-06-23T14:46:01.000Z\",\n \"last_seen\": \"2020-06-23T14:46:49.000Z\",\n \"rule\": {\n \"name\": \"Brute Force Attack Grouped By User \",\n \"version\": 12\n }\n }\n },\n \"message\": \"Detect Account Take Over (ATO) through brute force attempts\",\n \"tags\": [\n \"security:attack\",\n \"technique:T1110-brute-force\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"signal\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/security_monitoring/signals?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"2019-01-02T09:42:36.320Z\",\n \"query\": \"security:attack status:high\",\n \"to\": \"2019-01-03T09:42:36.320Z\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
"search"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"2019-01-02T09:42:36.320Z\",\n \"query\": \"security:attack status:high\",\n \"to\": \"2019-01-03T09:42:36.320Z\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
"search"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"from\": \"2019-01-02T09:42:36.320Z\",\n \"query\": \"security:attack status:high\",\n \"to\": \"2019-01-03T09:42:36.320Z\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"-timestamp\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
"search"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a signal's details",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id"
],
"variable": [
{
"key": "signal_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Get a signal's details."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"custom\": {\n \"workflow\": {\n \"first_seen\": \"2020-06-23T14:46:01.000Z\",\n \"last_seen\": \"2020-06-23T14:46:49.000Z\",\n \"rule\": {\n \"name\": \"Brute Force Attack Grouped By User \",\n \"version\": 12\n }\n }\n },\n \"message\": \"Detect Account Take Over (ATO) through brute force attempts\",\n \"tags\": [\n \"security:attack\",\n \"technique:T1110-brute-force\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\",\n \"irure_0\": {},\n \"minim_d\": {},\n \"sunt_3\": {},\n \"est_990\": {}\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"signal\"\n }\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a security filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Delete a specific security filter."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a quick list of security signals",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals?filter[query]=security:attack status:high&filter[from]=2019-01-02T09:42:36.320Z&filter[to]=2019-01-03T09:42:36.320Z&sort=timestamp&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==&page[limit]=25",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals"
],
"query": [
{
"key": "filter[query]",
"value": "security:attack status:high",
"description": "The search query for security signals."
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "The minimum timestamp for requested security signals."
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "The maximum timestamp for requested security signals."
},
{
"key": "sort",
"value": "timestamp",
"description": "The order of the security signals in results."
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "A list of results using the cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "25",
"description": "The maximum number of security signals in the response."
}
]
},
"description": "The list endpoint returns security signals that match a search query.\nBoth this endpoint and the POST endpoint can be used interchangeably when listing\nsecurity signals."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals?filter[query]=security:attack status:high&filter[from]=2019-01-02T09:42:36.320Z&filter[to]=2019-01-03T09:42:36.320Z&sort=timestamp&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==&page[limit]=25",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals"
],
"query": [
{
"key": "filter[query]",
"value": "security:attack status:high",
"description": "The search query for security signals."
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "The minimum timestamp for requested security signals."
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "The maximum timestamp for requested security signals."
},
{
"key": "sort",
"value": "timestamp",
"description": "The order of the security signals in results."
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "A list of results using the cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "25",
"description": "The maximum number of security signals in the response."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"custom\": {\n \"workflow\": {\n \"first_seen\": \"2020-06-23T14:46:01.000Z\",\n \"last_seen\": \"2020-06-23T14:46:49.000Z\",\n \"rule\": {\n \"name\": \"Brute Force Attack Grouped By User \",\n \"version\": 12\n }\n }\n },\n \"message\": \"Detect Account Take Over (ATO) through brute force attempts\",\n \"tags\": [\n \"security:attack\",\n \"technique:T1110-brute-force\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"signal\"\n },\n {\n \"attributes\": {\n \"custom\": {\n \"workflow\": {\n \"first_seen\": \"2020-06-23T14:46:01.000Z\",\n \"last_seen\": \"2020-06-23T14:46:49.000Z\",\n \"rule\": {\n \"name\": \"Brute Force Attack Grouped By User \",\n \"version\": 12\n }\n }\n },\n \"message\": \"Detect Account Take Over (ATO) through brute force attempts\",\n \"tags\": [\n \"security:attack\",\n \"technique:T1110-brute-force\"\n ],\n \"timestamp\": \"2019-01-02T09:42:36.320Z\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"signal\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/security_monitoring/signals?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals?filter[query]=security:attack status:high&filter[from]=2019-01-02T09:42:36.320Z&filter[to]=2019-01-03T09:42:36.320Z&sort=timestamp&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==&page[limit]=25",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals"
],
"query": [
{
"key": "filter[query]",
"value": "security:attack status:high",
"description": "The search query for security signals."
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "The minimum timestamp for requested security signals."
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "The maximum timestamp for requested security signals."
},
{
"key": "sort",
"value": "timestamp",
"description": "The order of the security signals in results."
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "A list of results using the cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "25",
"description": "The maximum number of security signals in the response."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals?filter[query]=security:attack status:high&filter[from]=2019-01-02T09:42:36.320Z&filter[to]=2019-01-03T09:42:36.320Z&sort=timestamp&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==&page[limit]=25",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals"
],
"query": [
{
"key": "filter[query]",
"value": "security:attack status:high",
"description": "The search query for security signals."
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "The minimum timestamp for requested security signals."
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "The maximum timestamp for requested security signals."
},
{
"key": "sort",
"value": "timestamp",
"description": "The order of the security signals in results."
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "A list of results using the cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "25",
"description": "The maximum number of security signals in the response."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals?filter[query]=security:attack status:high&filter[from]=2019-01-02T09:42:36.320Z&filter[to]=2019-01-03T09:42:36.320Z&sort=timestamp&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==&page[limit]=25",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals"
],
"query": [
{
"key": "filter[query]",
"value": "security:attack status:high",
"description": "The search query for security signals."
},
{
"key": "filter[from]",
"value": "2019-01-02T09:42:36.320Z",
"description": "The minimum timestamp for requested security signals."
},
{
"key": "filter[to]",
"value": "2019-01-03T09:42:36.320Z",
"description": "The maximum timestamp for requested security signals."
},
{
"key": "sort",
"value": "timestamp",
"description": "The order of the security signals in results."
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "A list of results using the cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "25",
"description": "The maximum number of security signals in the response."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get the list of signal-based notification rules",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules"
]
},
"description": "Returns the list of notification rules for security signals."
},
"response": [
{
"name": "The list of notification rules.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": 1722439510282,\n \"created_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"enabled\": true,\n \"modified_at\": 1722439510282,\n \"modified_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"version\": 1,\n \"time_aggregation\": 86400\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n },\n {\n \"attributes\": {\n \"created_at\": 1722439510282,\n \"created_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"enabled\": true,\n \"modified_at\": 1722439510282,\n \"modified_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"version\": 1,\n \"time_aggregation\": 86400\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get the list of vulnerability notification rules",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules"
]
},
"description": "Returns the list of notification rules for security vulnerabilities."
},
"response": [
{
"name": "The list of notification rules.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": 1722439510282,\n \"created_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"enabled\": true,\n \"modified_at\": 1722439510282,\n \"modified_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"version\": 1,\n \"time_aggregation\": 86400\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n },\n {\n \"attributes\": {\n \"created_at\": 1722439510282,\n \"created_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"enabled\": true,\n \"modified_at\": 1722439510282,\n \"modified_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"version\": 1,\n \"time_aggregation\": 86400\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a security filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": true,\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"version\": 1\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Update a specific security filter.\nReturns the security filter object when the request is successful."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": true,\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"version\": 1\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"exclusion_filters\": [\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n },\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_builtin\": false,\n \"is_enabled\": false,\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"version\": 1\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"security_filters\"\n },\n \"meta\": {\n \"warning\": \"All the security filters are disabled. As a result, no logs are being analyzed.\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": true,\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"version\": 1\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": true,\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"version\": 1\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": true,\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"version\": 1\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": true,\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"version\": 1\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": true,\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"version\": 1\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a new signal-based notification rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"name\": \"Rule 1\",\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"enabled\": true,\n \"time_aggregation\": 86400\n },\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules"
]
},
"description": "Create a new notification rule for security signals and return the created rule."
},
"response": [
{
"name": "Successfully created the notification rule.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"name\": \"Rule 1\",\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"enabled\": true,\n \"time_aggregation\": 86400\n },\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": 1722439510282,\n \"created_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"enabled\": true,\n \"modified_at\": 1722439510282,\n \"modified_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"version\": 1,\n \"time_aggregation\": 86400\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"name\": \"Rule 1\",\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"enabled\": true,\n \"time_aggregation\": 86400\n },\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"name\": \"Rule 1\",\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"enabled\": true,\n \"time_aggregation\": 86400\n },\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"name\": \"Rule 1\",\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"enabled\": true,\n \"time_aggregation\": 86400\n },\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a new vulnerability-based notification rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"name\": \"Rule 1\",\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"enabled\": true,\n \"time_aggregation\": 86400\n },\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules"
]
},
"description": "Create a new notification rule for security vulnerabilities and return the created rule."
},
"response": [
{
"name": "Successfully created the notification rule.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"name\": \"Rule 1\",\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"enabled\": true,\n \"time_aggregation\": 86400\n },\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": 1722439510282,\n \"created_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"enabled\": true,\n \"modified_at\": 1722439510282,\n \"modified_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"version\": 1,\n \"time_aggregation\": 86400\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"name\": \"Rule 1\",\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"enabled\": true,\n \"time_aggregation\": 86400\n },\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"name\": \"Rule 1\",\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"enabled\": true,\n \"time_aggregation\": 86400\n },\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"name\": \"Rule 1\",\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"enabled\": true,\n \"time_aggregation\": 86400\n },\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a security filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Get the details of a specific security filter.\n\nSee the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)\nfor more examples."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"exclusion_filters\": [\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n },\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_builtin\": false,\n \"is_enabled\": false,\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"version\": 1\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"security_filters\"\n },\n \"meta\": {\n \"warning\": \"All the security filters are disabled. As a result, no logs are being analyzed.\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a security filter",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"exclusion_filters\": [\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters"
]
},
"description": "Create a security filter.\n\nSee the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)\nfor more examples."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"exclusion_filters\": [\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"exclusion_filters\": [\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n },\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_builtin\": false,\n \"is_enabled\": false,\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"version\": 1\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"security_filters\"\n },\n \"meta\": {\n \"warning\": \"All the security filters are disabled. As a result, no logs are being analyzed.\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"exclusion_filters\": [\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"exclusion_filters\": [\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"exclusion_filters\": [\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"exclusion_filters\": [\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": true\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all security filters",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters"
]
},
"description": "Get the list of configured security filters with their definitions."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"exclusion_filters\": [\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n },\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_builtin\": false,\n \"is_enabled\": false,\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"version\": 1\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"security_filters\"\n },\n {\n \"attributes\": {\n \"exclusion_filters\": [\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n },\n {\n \"name\": \"Exclude staging\",\n \"query\": \"source:staging\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_builtin\": false,\n \"is_enabled\": false,\n \"name\": \"Custom security filter\",\n \"query\": \"service:api\",\n \"version\": 1\n },\n \"id\": \"3dd-0uc-h1s\",\n \"type\": \"security_filters\"\n }\n ],\n \"meta\": {\n \"warning\": \"All the security filters are disabled. As a result, no logs are being analyzed.\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get details of a signal-based notification rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Get the details of a notification rule for security signals."
},
"response": [
{
"name": "Notification rule details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": 1722439510282,\n \"created_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"enabled\": true,\n \"modified_at\": 1722439510282,\n \"modified_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"version\": 1,\n \"time_aggregation\": 86400\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get details of a vulnerability notification rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Get the details of a notification rule for security vulnerabilities."
},
"response": [
{
"name": "Notification rule details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": 1722439510282,\n \"created_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"enabled\": true,\n \"modified_at\": 1722439510282,\n \"modified_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"version\": 1,\n \"time_aggregation\": 86400\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Patch a signal-based notification rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"time_aggregation\": 86400,\n \"version\": 1\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Partially update the notification rule. All fields are optional; if a field is not provided, it is not updated."
},
"response": [
{
"name": "Notification rule successfully patched.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"time_aggregation\": 86400,\n \"version\": 1\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": 1722439510282,\n \"created_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"enabled\": true,\n \"modified_at\": 1722439510282,\n \"modified_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"version\": 1,\n \"time_aggregation\": 86400\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"time_aggregation\": 86400,\n \"version\": 1\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"time_aggregation\": 86400,\n \"version\": 1\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"time_aggregation\": 86400,\n \"version\": 1\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "The server cannot process the request because it contains invalid data.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"time_aggregation\": 86400,\n \"version\": 1\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"time_aggregation\": 86400,\n \"version\": 1\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Patch a vulnerability-based notification rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"time_aggregation\": 86400,\n \"version\": 1\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Partially update the notification rule. All fields are optional; if a field is not provided, it is not updated."
},
"response": [
{
"name": "Notification rule successfully patched.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"time_aggregation\": 86400,\n \"version\": 1\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": 1722439510282,\n \"created_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"enabled\": true,\n \"modified_at\": 1722439510282,\n \"modified_by\": {\n \"handle\": \"john.doe@domain.com\",\n \"name\": \"John Doe\"\n },\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"version\": 1,\n \"time_aggregation\": 86400\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"time_aggregation\": 86400,\n \"version\": 1\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"time_aggregation\": 86400,\n \"version\": 1\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"time_aggregation\": 86400,\n \"version\": 1\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "The server cannot process the request because it contains invalid data.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"time_aggregation\": 86400,\n \"version\": 1\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"aliqua95\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"adipisicingb3\": {},\n \"nulla_70\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"enabled\": true,\n \"name\": \"Rule 1\",\n \"selectors\": {\n \"trigger_source\": \"security_findings\",\n \"query\": \"(source:production_service OR env:prod)\",\n \"rule_types\": [\n \"misconfiguration\",\n \"attack_path\"\n ],\n \"severities\": [\n \"critical\",\n \"critical\"\n ]\n },\n \"targets\": [\n \"@john.doe@email.com\"\n ],\n \"time_aggregation\": 86400,\n \"version\": 1\n },\n \"id\": \"aaa-bbb-ccc\",\n \"type\": \"notification_rules\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a signal-based notification rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Delete a notification rule for security signals."
},
"response": [
{
"name": "Rule successfully deleted.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/signals/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"signals",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a vulnerability-based notification rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id",
"value": "consectetur consequat dolor"
}
]
},
"description": "Delete a notification rule for security vulnerabilities."
},
"response": [
{
"name": "Rule successfully deleted.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security/vulnerabilities/notification_rules/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security",
"vulnerabilities",
"notification_rules",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List resource filters",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/resource_filters?cloud_provider=consectetur consequat dolor&account_id=consectetur consequat dolor&skip_cache=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"resource_filters"
],
"query": [
{
"key": "cloud_provider",
"value": "consectetur consequat dolor",
"description": "Filter resource filters by cloud provider (e.g. aws, gcp, azure)."
},
{
"key": "account_id",
"value": "consectetur consequat dolor",
"description": "Filter resource filters by cloud provider account ID. This parameter is only valid when provider is specified."
},
{
"key": "skip_cache",
"value": "true",
"description": "Skip cache for resource filters."
}
]
},
"description": "List resource filters."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/resource_filters?cloud_provider=consectetur consequat dolor&account_id=consectetur consequat dolor&skip_cache=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"resource_filters"
],
"query": [
{
"key": "cloud_provider",
"value": "consectetur consequat dolor",
"description": "Filter resource filters by cloud provider (e.g. aws, gcp, azure)."
},
{
"key": "account_id",
"value": "consectetur consequat dolor",
"description": "Filter resource filters by cloud provider account ID. This parameter is only valid when provider is specified."
},
{
"key": "skip_cache",
"value": "true",
"description": "Skip cache for resource filters."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"cloud_provider\": {\n \"inea5\": {\n \"culpab3\": [\n \"environment:production\",\n \"environment:production\"\n ],\n \"Excepteure\": [\n \"environment:production\",\n \"environment:production\"\n ]\n },\n \"irureb5\": {\n \"enim2\": [\n \"environment:production\",\n \"environment:production\"\n ],\n \"irure_a5\": [\n \"environment:production\",\n \"environment:production\"\n ],\n \"consequat31a\": [\n \"environment:production\",\n \"environment:production\"\n ]\n }\n },\n \"uuid\": \"sunt quis\"\n },\n \"id\": \"csm_resource_filter\",\n \"type\": \"csm_resource_filter\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/resource_filters?cloud_provider=consectetur consequat dolor&account_id=consectetur consequat dolor&skip_cache=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"resource_filters"
],
"query": [
{
"key": "cloud_provider",
"value": "consectetur consequat dolor",
"description": "Filter resource filters by cloud provider (e.g. aws, gcp, azure)."
},
{
"key": "account_id",
"value": "consectetur consequat dolor",
"description": "Filter resource filters by cloud provider account ID. This parameter is only valid when provider is specified."
},
{
"key": "skip_cache",
"value": "true",
"description": "Skip cache for resource filters."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/resource_filters?cloud_provider=consectetur consequat dolor&account_id=consectetur consequat dolor&skip_cache=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"resource_filters"
],
"query": [
{
"key": "cloud_provider",
"value": "consectetur consequat dolor",
"description": "Filter resource filters by cloud provider (e.g. aws, gcp, azure)."
},
{
"key": "account_id",
"value": "consectetur consequat dolor",
"description": "Filter resource filters by cloud provider account ID. This parameter is only valid when provider is specified."
},
{
"key": "skip_cache",
"value": "true",
"description": "Skip cache for resource filters."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/resource_filters?cloud_provider=consectetur consequat dolor&account_id=consectetur consequat dolor&skip_cache=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"resource_filters"
],
"query": [
{
"key": "cloud_provider",
"value": "consectetur consequat dolor",
"description": "Filter resource filters by cloud provider (e.g. aws, gcp, azure)."
},
{
"key": "account_id",
"value": "consectetur consequat dolor",
"description": "Filter resource filters by cloud provider account ID. This parameter is only valid when provider is specified."
},
{
"key": "skip_cache",
"value": "true",
"description": "Skip cache for resource filters."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update resource filters",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cloud_provider\": {\n \"in3c\": {\n \"aute_3\": [\n \"environment:production\",\n \"environment:production\"\n ],\n \"voluptate_f\": [\n \"environment:production\",\n \"environment:production\"\n ],\n \"dolore_c\": [\n \"environment:production\",\n \"environment:production\"\n ]\n }\n },\n \"uuid\": \"aliquip Duis eu amet\"\n },\n \"type\": \"csm_resource_filter\",\n \"id\": \"csm_resource_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/resource_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"resource_filters"
]
},
"description": "Update resource filters."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cloud_provider\": {\n \"in3c\": {\n \"aute_3\": [\n \"environment:production\",\n \"environment:production\"\n ],\n \"voluptate_f\": [\n \"environment:production\",\n \"environment:production\"\n ],\n \"dolore_c\": [\n \"environment:production\",\n \"environment:production\"\n ]\n }\n },\n \"uuid\": \"aliquip Duis eu amet\"\n },\n \"type\": \"csm_resource_filter\",\n \"id\": \"csm_resource_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/resource_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"resource_filters"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"cloud_provider\": {\n \"quis45\": {\n \"ina\": [\n \"environment:production\",\n \"environment:production\"\n ]\n }\n },\n \"uuid\": \"magna aliqua\"\n },\n \"type\": \"csm_resource_filter\",\n \"id\": \"csm_resource_filter\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cloud_provider\": {\n \"in3c\": {\n \"aute_3\": [\n \"environment:production\",\n \"environment:production\"\n ],\n \"voluptate_f\": [\n \"environment:production\",\n \"environment:production\"\n ],\n \"dolore_c\": [\n \"environment:production\",\n \"environment:production\"\n ]\n }\n },\n \"uuid\": \"aliquip Duis eu amet\"\n },\n \"type\": \"csm_resource_filter\",\n \"id\": \"csm_resource_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/resource_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"resource_filters"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cloud_provider\": {\n \"in3c\": {\n \"aute_3\": [\n \"environment:production\",\n \"environment:production\"\n ],\n \"voluptate_f\": [\n \"environment:production\",\n \"environment:production\"\n ],\n \"dolore_c\": [\n \"environment:production\",\n \"environment:production\"\n ]\n }\n },\n \"uuid\": \"aliquip Duis eu amet\"\n },\n \"type\": \"csm_resource_filter\",\n \"id\": \"csm_resource_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/resource_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"resource_filters"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cloud_provider\": {\n \"in3c\": {\n \"aute_3\": [\n \"environment:production\",\n \"environment:production\"\n ],\n \"voluptate_f\": [\n \"environment:production\",\n \"environment:production\"\n ],\n \"dolore_c\": [\n \"environment:production\",\n \"environment:production\"\n ]\n }\n },\n \"uuid\": \"aliquip Duis eu amet\"\n },\n \"type\": \"csm_resource_filter\",\n \"id\": \"csm_resource_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/cloud_security_management/resource_filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cloud_security_management",
"resource_filters"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Create and manage your security rules, signals, filters, and more. See the [Datadog Security page](https://docs.datadoghq.com/security/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Sensitive Data Scanner",
"item": [
{
"name": "List Scanning Groups",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
},
"description": "List all the Scanning groups in your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"cillumba7\": {},\n \"officia_5\": {}\n },\n \"id\": \"elit ut Excepteur tempor nulla\",\n \"relationships\": {\n \"groups\": {\n \"data\": [\n {\n \"id\": \"nulla sed aute\",\n \"type\": \"sensitive_data_scanner_group\"\n },\n {\n \"id\": \"id culpa\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_configuration\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"description\": \"eu\",\n \"excluded_namespaces\": [\n \"admin.name\"\n ],\n \"included_keyword_configuration\": {\n \"keywords\": [\n \"credit card\",\n \"cc\"\n ],\n \"character_count\": 30,\n \"use_recommended_keywords\": false\n },\n \"is_enabled\": false,\n \"name\": \"mollit fugiat ea\",\n \"namespaces\": [\n \"admin\"\n ],\n \"pattern\": \"ad\",\n \"priority\": 2,\n \"tags\": [\n \"est voluptate\",\n \"laborum eu sed culpa dolor\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": 16705535,\n \"replacement_string\": \"elit non consequat\",\n \"type\": \"none\"\n }\n },\n \"id\": \"sit nostrud Duis\",\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"exercitation sed\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"ullamco in eu\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n },\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"attributes\": {\n \"description\": \"non est sed dolor\",\n \"excluded_namespaces\": [\n \"admin.name\"\n ],\n \"included_keyword_configuration\": {\n \"keywords\": [\n \"credit card\",\n \"cc\"\n ],\n \"character_count\": 30,\n \"use_recommended_keywords\": false\n },\n \"is_enabled\": true,\n \"name\": \"fugiat dolor in ad\",\n \"namespaces\": [\n \"admin\"\n ],\n \"pattern\": \"fugiat do Lorem in\",\n \"priority\": 3,\n \"tags\": [\n \"ut u\",\n \"voluptate Excepteur anim\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": 4864080,\n \"replacement_string\": \"ut e\",\n \"type\": \"none\"\n }\n },\n \"id\": \"aute Duis exercitation eu\",\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"reprehenderit fugiat labore et qui\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"dolor aute cillum magna\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n },\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ],\n \"meta\": {\n \"count_limit\": 84449251,\n \"group_count_limit\": -52989395,\n \"is_pci_compliant\": true,\n \"version\": 0\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Reorder Groups",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"cupidatat irure\",\n \"relationships\": {\n \"groups\": {\n \"data\": [\n {\n \"id\": \"mollit tempor\",\n \"type\": \"sensitive_data_scanner_group\"\n },\n {\n \"id\": \"laboris esse est eu\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_configuration\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
},
"description": "Reorder the list of groups."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"cupidatat irure\",\n \"relationships\": {\n \"groups\": {\n \"data\": [\n {\n \"id\": \"mollit tempor\",\n \"type\": \"sensitive_data_scanner_group\"\n },\n {\n \"id\": \"laboris esse est eu\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_configuration\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"meta\": {\n \"count_limit\": 81290309,\n \"group_count_limit\": -72430869,\n \"is_pci_compliant\": false,\n \"version\": 0\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"cupidatat irure\",\n \"relationships\": {\n \"groups\": {\n \"data\": [\n {\n \"id\": \"mollit tempor\",\n \"type\": \"sensitive_data_scanner_group\"\n },\n {\n \"id\": \"laboris esse est eu\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_configuration\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"cupidatat irure\",\n \"relationships\": {\n \"groups\": {\n \"data\": [\n {\n \"id\": \"mollit tempor\",\n \"type\": \"sensitive_data_scanner_group\"\n },\n {\n \"id\": \"laboris esse est eu\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_configuration\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"cupidatat irure\",\n \"relationships\": {\n \"groups\": {\n \"data\": [\n {\n \"id\": \"mollit tempor\",\n \"type\": \"sensitive_data_scanner_group\"\n },\n {\n \"id\": \"laboris esse est eu\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_configuration\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List standard patterns",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/standard-patterns",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"standard-patterns"
]
},
"description": "Returns all standard patterns."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/standard-patterns",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"standard-patterns"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"description\": \"tempor esse ea\",\n \"included_keywords\": [\n \"magna\",\n \"culpa enim\"\n ],\n \"name\": \"est\",\n \"priority\": 3,\n \"tags\": [\n \"laborum elit dolore\",\n \"dolor mollit\"\n ]\n },\n \"id\": \"incididunt culpa Excepteur labore amet\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n },\n {\n \"attributes\": {\n \"description\": \"in Ut dolor cillum in\",\n \"included_keywords\": [\n \"ea id\",\n \"commodo dolor est\"\n ],\n \"name\": \"consequat adipisicing ut quis ad\",\n \"priority\": 1,\n \"tags\": [\n \"irure est in consectetur sit\",\n \"velit ea Duis\"\n ]\n },\n \"id\": \"occaecat culpa\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/standard-patterns",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"standard-patterns"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/standard-patterns",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"standard-patterns"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/standard-patterns",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"standard-patterns"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create Scanning Group",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_group\",\n \"attributes\": {\n \"description\": \"non ad magna\",\n \"filter\": {\n \"query\": \"aute\"\n },\n \"is_enabled\": false,\n \"name\": \"exercitation eiusmod Ut\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"sunt\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"in amet quis ut\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"sed\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n }\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups"
]
},
"description": "Create a scanning group.\nThe request MAY include a configuration relationship.\nA rules relationship can be omitted entirely, but if it is included it MUST be\nnull or an empty array (rules cannot be created at the same time).\nThe new group will be ordered last within the configuration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_group\",\n \"attributes\": {\n \"description\": \"non ad magna\",\n \"filter\": {\n \"query\": \"aute\"\n },\n \"is_enabled\": false,\n \"name\": \"exercitation eiusmod Ut\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"sunt\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"in amet quis ut\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"sed\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n }\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"anim\",\n \"filter\": {\n \"query\": \"aute\"\n },\n \"is_enabled\": true,\n \"name\": \"do labore veniam\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"id\": \"Duis proident a\",\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"ea incididunt cupidatat\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"ea adipisicing\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"Excepteur in aliqua\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_group\"\n },\n \"meta\": {\n \"version\": 0\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_group\",\n \"attributes\": {\n \"description\": \"non ad magna\",\n \"filter\": {\n \"query\": \"aute\"\n },\n \"is_enabled\": false,\n \"name\": \"exercitation eiusmod Ut\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"sunt\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"in amet quis ut\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"sed\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n }\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_group\",\n \"attributes\": {\n \"description\": \"non ad magna\",\n \"filter\": {\n \"query\": \"aute\"\n },\n \"is_enabled\": false,\n \"name\": \"exercitation eiusmod Ut\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"sunt\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"in amet quis ut\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"sed\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n }\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_group\",\n \"attributes\": {\n \"description\": \"non ad magna\",\n \"filter\": {\n \"query\": \"aute\"\n },\n \"is_enabled\": false,\n \"name\": \"exercitation eiusmod Ut\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"sunt\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"in amet quis ut\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"sed\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n }\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update Scanning Group",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Ut exercitation in\",\n \"filter\": {\n \"query\": \"commodo quis labore\"\n },\n \"is_enabled\": true,\n \"name\": \"\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"id\": \"proident id veniam nulla occaecat\",\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"eu\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"nulla fugiat\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"et fugiat amet laborum\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_group\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups",
":group_id"
],
"variable": [
{
"key": "group_id",
"value": "tempor ipsum enim ea"
}
]
},
"description": "Update a group, including the order of the rules.\nRules within the group are reordered by including a rules relationship. If the rules\nrelationship is present, its data section MUST contain linkages for all of the rules\ncurrently in the group, and MUST NOT contain any others."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Ut exercitation in\",\n \"filter\": {\n \"query\": \"commodo quis labore\"\n },\n \"is_enabled\": true,\n \"name\": \"\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"id\": \"proident id veniam nulla occaecat\",\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"eu\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"nulla fugiat\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"et fugiat amet laborum\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_group\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups",
":group_id"
],
"variable": [
{
"key": "group_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"meta\": {\n \"version\": 0\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Ut exercitation in\",\n \"filter\": {\n \"query\": \"commodo quis labore\"\n },\n \"is_enabled\": true,\n \"name\": \"\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"id\": \"proident id veniam nulla occaecat\",\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"eu\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"nulla fugiat\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"et fugiat amet laborum\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_group\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups",
":group_id"
],
"variable": [
{
"key": "group_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Ut exercitation in\",\n \"filter\": {\n \"query\": \"commodo quis labore\"\n },\n \"is_enabled\": true,\n \"name\": \"\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"id\": \"proident id veniam nulla occaecat\",\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"eu\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"nulla fugiat\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"et fugiat amet laborum\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_group\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups",
":group_id"
],
"variable": [
{
"key": "group_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Ut exercitation in\",\n \"filter\": {\n \"query\": \"commodo quis labore\"\n },\n \"is_enabled\": true,\n \"name\": \"\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"id\": \"proident id veniam nulla occaecat\",\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"eu\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"nulla fugiat\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"et fugiat amet laborum\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_group\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups",
":group_id"
],
"variable": [
{
"key": "group_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"Ut exercitation in\",\n \"filter\": {\n \"query\": \"commodo quis labore\"\n },\n \"is_enabled\": true,\n \"name\": \"\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"id\": \"proident id veniam nulla occaecat\",\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"eu\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"nulla fugiat\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"et fugiat amet laborum\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_group\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups",
":group_id"
],
"variable": [
{
"key": "group_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete Scanning Group",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups",
":group_id"
],
"variable": [
{
"key": "group_id",
"value": "tempor ipsum enim ea"
}
]
},
"description": "Delete a given group."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups",
":group_id"
],
"variable": [
{
"key": "group_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"meta\": {\n \"version\": 0\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups",
":group_id"
],
"variable": [
{
"key": "group_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups",
":group_id"
],
"variable": [
{
"key": "group_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups",
":group_id"
],
"variable": [
{
"key": "group_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups",
":group_id"
],
"variable": [
{
"key": "group_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create Scanning Rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_rule\",\n \"attributes\": {\n \"description\": \"cupidatat laborum\",\n \"excluded_namespaces\": [\n \"admin.name\"\n ],\n \"included_keyword_configuration\": {\n \"keywords\": [\n \"credit card\",\n \"cc\"\n ],\n \"character_count\": 30,\n \"use_recommended_keywords\": true\n },\n \"is_enabled\": false,\n \"name\": \"ad consequat\",\n \"namespaces\": [\n \"admin\"\n ],\n \"pattern\": \"anim deserunt id esse\",\n \"priority\": 1,\n \"tags\": [\n \"exercitation\",\n \"anim dolor dolore qui i\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": 92466298,\n \"replacement_string\": \"aute Duis ex mollit\",\n \"type\": \"none\"\n }\n },\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"officia deserunt in nulla\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"veniam pariatur qui officia s\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n }\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules"
]
},
"description": "Create a scanning rule in a sensitive data scanner group, ordered last.\nThe posted rule MUST include a group relationship.\nIt MUST include either a standard_pattern relationship or a regex attribute, but not both.\nIf included_attributes is empty or missing, we will scan all attributes except\nexcluded_attributes. If both are missing, we will scan the whole event."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_rule\",\n \"attributes\": {\n \"description\": \"cupidatat laborum\",\n \"excluded_namespaces\": [\n \"admin.name\"\n ],\n \"included_keyword_configuration\": {\n \"keywords\": [\n \"credit card\",\n \"cc\"\n ],\n \"character_count\": 30,\n \"use_recommended_keywords\": true\n },\n \"is_enabled\": false,\n \"name\": \"ad consequat\",\n \"namespaces\": [\n \"admin\"\n ],\n \"pattern\": \"anim deserunt id esse\",\n \"priority\": 1,\n \"tags\": [\n \"exercitation\",\n \"anim dolor dolore qui i\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": 92466298,\n \"replacement_string\": \"aute Duis ex mollit\",\n \"type\": \"none\"\n }\n },\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"officia deserunt in nulla\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"veniam pariatur qui officia s\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n }\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"reprehenderit eiusmod qui\",\n \"excluded_namespaces\": [\n \"admin.name\"\n ],\n \"included_keyword_configuration\": {\n \"keywords\": [\n \"credit card\",\n \"cc\"\n ],\n \"character_count\": 30,\n \"use_recommended_keywords\": false\n },\n \"is_enabled\": true,\n \"name\": \"anim\",\n \"namespaces\": [\n \"admin\"\n ],\n \"pattern\": \"sunt eiu\",\n \"priority\": 1,\n \"tags\": [\n \"elit labore deserunt Duis in\",\n \"dolor Excepteur\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": 49742081,\n \"replacement_string\": \"sint ali\",\n \"type\": \"none\"\n }\n },\n \"id\": \"quis enim sunt esse dolore\",\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"consectetur in commodo Excepteur\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"est tempor officia proi\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n },\n \"type\": \"sensitive_data_scanner_rule\"\n },\n \"meta\": {\n \"version\": 0\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_rule\",\n \"attributes\": {\n \"description\": \"cupidatat laborum\",\n \"excluded_namespaces\": [\n \"admin.name\"\n ],\n \"included_keyword_configuration\": {\n \"keywords\": [\n \"credit card\",\n \"cc\"\n ],\n \"character_count\": 30,\n \"use_recommended_keywords\": true\n },\n \"is_enabled\": false,\n \"name\": \"ad consequat\",\n \"namespaces\": [\n \"admin\"\n ],\n \"pattern\": \"anim deserunt id esse\",\n \"priority\": 1,\n \"tags\": [\n \"exercitation\",\n \"anim dolor dolore qui i\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": 92466298,\n \"replacement_string\": \"aute Duis ex mollit\",\n \"type\": \"none\"\n }\n },\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"officia deserunt in nulla\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"veniam pariatur qui officia s\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n }\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_rule\",\n \"attributes\": {\n \"description\": \"cupidatat laborum\",\n \"excluded_namespaces\": [\n \"admin.name\"\n ],\n \"included_keyword_configuration\": {\n \"keywords\": [\n \"credit card\",\n \"cc\"\n ],\n \"character_count\": 30,\n \"use_recommended_keywords\": true\n },\n \"is_enabled\": false,\n \"name\": \"ad consequat\",\n \"namespaces\": [\n \"admin\"\n ],\n \"pattern\": \"anim deserunt id esse\",\n \"priority\": 1,\n \"tags\": [\n \"exercitation\",\n \"anim dolor dolore qui i\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": 92466298,\n \"replacement_string\": \"aute Duis ex mollit\",\n \"type\": \"none\"\n }\n },\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"officia deserunt in nulla\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"veniam pariatur qui officia s\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n }\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_rule\",\n \"attributes\": {\n \"description\": \"cupidatat laborum\",\n \"excluded_namespaces\": [\n \"admin.name\"\n ],\n \"included_keyword_configuration\": {\n \"keywords\": [\n \"credit card\",\n \"cc\"\n ],\n \"character_count\": 30,\n \"use_recommended_keywords\": true\n },\n \"is_enabled\": false,\n \"name\": \"ad consequat\",\n \"namespaces\": [\n \"admin\"\n ],\n \"pattern\": \"anim deserunt id esse\",\n \"priority\": 1,\n \"tags\": [\n \"exercitation\",\n \"anim dolor dolore qui i\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": 92466298,\n \"replacement_string\": \"aute Duis ex mollit\",\n \"type\": \"none\"\n }\n },\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"officia deserunt in nulla\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"veniam pariatur qui officia s\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n }\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update Scanning Rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"amet ipsum veniam\",\n \"excluded_namespaces\": [\n \"admin.name\"\n ],\n \"included_keyword_configuration\": {\n \"keywords\": [\n \"credit card\",\n \"cc\"\n ],\n \"character_count\": 30,\n \"use_recommended_keywords\": false\n },\n \"is_enabled\": true,\n \"name\": \"deserunt Ut amet magna ullamco\",\n \"namespaces\": [\n \"admin\"\n ],\n \"pattern\": \"u\",\n \"priority\": 1,\n \"tags\": [\n \"deserunt aute irure\",\n \"cillum enim pariatur\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": 81664823,\n \"replacement_string\": \"ut in commodo minim\",\n \"type\": \"none\"\n }\n },\n \"id\": \"sit Lorem ullamco est\",\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"dolor ipsum Excepteur\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"laboris sed enim\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n },\n \"type\": \"sensitive_data_scanner_rule\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id",
"value": "tempor ipsum enim ea"
}
]
},
"description": "Update a scanning rule.\nThe request body MUST NOT include a standard_pattern relationship, as that relationship\nis non-editable. Trying to edit the regex attribute of a rule with a standard_pattern\nrelationship will also result in an error."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"amet ipsum veniam\",\n \"excluded_namespaces\": [\n \"admin.name\"\n ],\n \"included_keyword_configuration\": {\n \"keywords\": [\n \"credit card\",\n \"cc\"\n ],\n \"character_count\": 30,\n \"use_recommended_keywords\": false\n },\n \"is_enabled\": true,\n \"name\": \"deserunt Ut amet magna ullamco\",\n \"namespaces\": [\n \"admin\"\n ],\n \"pattern\": \"u\",\n \"priority\": 1,\n \"tags\": [\n \"deserunt aute irure\",\n \"cillum enim pariatur\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": 81664823,\n \"replacement_string\": \"ut in commodo minim\",\n \"type\": \"none\"\n }\n },\n \"id\": \"sit Lorem ullamco est\",\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"dolor ipsum Excepteur\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"laboris sed enim\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n },\n \"type\": \"sensitive_data_scanner_rule\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"meta\": {\n \"version\": 0\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"amet ipsum veniam\",\n \"excluded_namespaces\": [\n \"admin.name\"\n ],\n \"included_keyword_configuration\": {\n \"keywords\": [\n \"credit card\",\n \"cc\"\n ],\n \"character_count\": 30,\n \"use_recommended_keywords\": false\n },\n \"is_enabled\": true,\n \"name\": \"deserunt Ut amet magna ullamco\",\n \"namespaces\": [\n \"admin\"\n ],\n \"pattern\": \"u\",\n \"priority\": 1,\n \"tags\": [\n \"deserunt aute irure\",\n \"cillum enim pariatur\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": 81664823,\n \"replacement_string\": \"ut in commodo minim\",\n \"type\": \"none\"\n }\n },\n \"id\": \"sit Lorem ullamco est\",\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"dolor ipsum Excepteur\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"laboris sed enim\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n },\n \"type\": \"sensitive_data_scanner_rule\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"amet ipsum veniam\",\n \"excluded_namespaces\": [\n \"admin.name\"\n ],\n \"included_keyword_configuration\": {\n \"keywords\": [\n \"credit card\",\n \"cc\"\n ],\n \"character_count\": 30,\n \"use_recommended_keywords\": false\n },\n \"is_enabled\": true,\n \"name\": \"deserunt Ut amet magna ullamco\",\n \"namespaces\": [\n \"admin\"\n ],\n \"pattern\": \"u\",\n \"priority\": 1,\n \"tags\": [\n \"deserunt aute irure\",\n \"cillum enim pariatur\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": 81664823,\n \"replacement_string\": \"ut in commodo minim\",\n \"type\": \"none\"\n }\n },\n \"id\": \"sit Lorem ullamco est\",\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"dolor ipsum Excepteur\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"laboris sed enim\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n },\n \"type\": \"sensitive_data_scanner_rule\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"amet ipsum veniam\",\n \"excluded_namespaces\": [\n \"admin.name\"\n ],\n \"included_keyword_configuration\": {\n \"keywords\": [\n \"credit card\",\n \"cc\"\n ],\n \"character_count\": 30,\n \"use_recommended_keywords\": false\n },\n \"is_enabled\": true,\n \"name\": \"deserunt Ut amet magna ullamco\",\n \"namespaces\": [\n \"admin\"\n ],\n \"pattern\": \"u\",\n \"priority\": 1,\n \"tags\": [\n \"deserunt aute irure\",\n \"cillum enim pariatur\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": 81664823,\n \"replacement_string\": \"ut in commodo minim\",\n \"type\": \"none\"\n }\n },\n \"id\": \"sit Lorem ullamco est\",\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"dolor ipsum Excepteur\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"laboris sed enim\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n },\n \"type\": \"sensitive_data_scanner_rule\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"amet ipsum veniam\",\n \"excluded_namespaces\": [\n \"admin.name\"\n ],\n \"included_keyword_configuration\": {\n \"keywords\": [\n \"credit card\",\n \"cc\"\n ],\n \"character_count\": 30,\n \"use_recommended_keywords\": false\n },\n \"is_enabled\": true,\n \"name\": \"deserunt Ut amet magna ullamco\",\n \"namespaces\": [\n \"admin\"\n ],\n \"pattern\": \"u\",\n \"priority\": 1,\n \"tags\": [\n \"deserunt aute irure\",\n \"cillum enim pariatur\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": 81664823,\n \"replacement_string\": \"ut in commodo minim\",\n \"type\": \"none\"\n }\n },\n \"id\": \"sit Lorem ullamco est\",\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"dolor ipsum Excepteur\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"laboris sed enim\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n },\n \"type\": \"sensitive_data_scanner_rule\"\n },\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete Scanning Rule",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id",
"value": "tempor ipsum enim ea"
}
]
},
"description": "Delete a given rule."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"meta\": {\n \"version\": 0\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"version\": 0\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules",
":rule_id"
],
"variable": [
{
"key": "rule_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Create, update, delete, and retrieve sensitive data scanner groups and rules. See the [Sensitive Data Scanner page](https://docs.datadoghq.com/sensitive_data_scanner/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Service Accounts",
"item": [
{
"name": "Create a service account",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"email\": \"jane.doe@example.com\",\n \"service_account\": true,\n \"name\": \"non nisi labore\",\n \"title\": \"quis voluptate in aliqua\"\n },\n \"type\": \"users\",\n \"relationships\": {\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts"
]
},
"description": "Create a service account for your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"email\": \"jane.doe@example.com\",\n \"service_account\": true,\n \"name\": \"non nisi labore\",\n \"title\": \"quis voluptate in aliqua\"\n },\n \"type\": \"users\",\n \"relationships\": {\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"2005-12-14T18:17:57.666Z\",\n \"disabled\": false,\n \"email\": \"quis nulla dolor ullamco\",\n \"handle\": \"magna aute Excepteur cillum qui\",\n \"icon\": \"eu occaecat anim \",\n \"modified_at\": \"1990-12-01T02:41:26.199Z\",\n \"name\": \"voluptate Ut cillum minim\",\n \"service_account\": false,\n \"status\": \"Duis pariatur\",\n \"title\": \"sunt irure et\",\n \"verified\": true\n },\n \"id\": \"sit veniam velit ipsum dolore\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n \"included\": [\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"1989-01-21T18:12:19.298Z\",\n \"description\": \"culpa commodo adipisicing in\",\n \"disabled\": false,\n \"modified_at\": \"1951-10-29T07:06:58.474Z\",\n \"name\": \"veniam in nisi cillum irure\",\n \"public_id\": \"Ut esse pariatur\",\n \"sharing\": \"nisi laborum ut aliqua\",\n \"url\": \"sint ea quis sit\"\n },\n \"id\": \"ut exe\"\n },\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"1997-09-29T04:11:37.259Z\",\n \"description\": \"ullamco mollit occaecat in anim\",\n \"disabled\": false,\n \"modified_at\": \"2020-02-24T20:19:57.938Z\",\n \"name\": \"reprehenderit Ut dolore minim\",\n \"public_id\": \"do qui ad laborum\",\n \"sharing\": \"enim deserunt cillum\",\n \"url\": \"aliquip id\"\n },\n \"id\": \"voluptate sunt ad incididunt\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"email\": \"jane.doe@example.com\",\n \"service_account\": true,\n \"name\": \"non nisi labore\",\n \"title\": \"quis voluptate in aliqua\"\n },\n \"type\": \"users\",\n \"relationships\": {\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"email\": \"jane.doe@example.com\",\n \"service_account\": true,\n \"name\": \"non nisi labore\",\n \"title\": \"quis voluptate in aliqua\"\n },\n \"type\": \"users\",\n \"relationships\": {\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"email\": \"jane.doe@example.com\",\n \"service_account\": true,\n \"name\": \"non nisi labore\",\n \"title\": \"quis voluptate in aliqua\"\n },\n \"type\": \"users\",\n \"relationships\": {\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get one application key for this service account",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id",
"value": "00000000-0000-1234-0000-000000000000"
},
{
"key": "app_key_id",
"value": "pariatur consequat"
}
]
},
"description": "Get an application key owned by this service account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id"
},
{
"key": "app_key_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"last4\": \"abcd\",\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"et ipsum conse\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"2024-03-11T02:00:00.589Z\",\n \"disabled\": false,\n \"email\": \"Ut\",\n \"handle\": \"E\",\n \"icon\": \"Ut in nisi\",\n \"modified_at\": \"1947-01-29T16:31:15.257Z\",\n \"name\": \"consectetur cupidatat nulla sed\",\n \"service_account\": false,\n \"status\": \"ullamco dolore minim\",\n \"title\": \"irure incididunt adipisicing ut\",\n \"verified\": false\n },\n \"id\": \"voluptate aute et irure Excepteur\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1977-12-25T07:31:31.025Z\",\n \"disabled\": false,\n \"email\": \"officia est eu irure ut\",\n \"handle\": \"occaecat\",\n \"icon\": \"ex magna dolore in\",\n \"modified_at\": \"1977-11-14T04:52:53.308Z\",\n \"name\": \"Lo\",\n \"service_account\": false,\n \"status\": \"consectetur in ut\",\n \"title\": \"fugiat aliqua\",\n \"verified\": false\n },\n \"id\": \"ea voluptate nulla dolor\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id"
},
{
"key": "app_key_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id"
},
{
"key": "app_key_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id"
},
{
"key": "app_key_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Edit an application key for this service account",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id",
"value": "00000000-0000-1234-0000-000000000000"
},
{
"key": "app_key_id",
"value": "pariatur consequat"
}
]
},
"description": "Edit an application key owned by this service account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id"
},
{
"key": "app_key_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"last4\": \"abcd\",\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"et ipsum conse\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"2024-03-11T02:00:00.589Z\",\n \"disabled\": false,\n \"email\": \"Ut\",\n \"handle\": \"E\",\n \"icon\": \"Ut in nisi\",\n \"modified_at\": \"1947-01-29T16:31:15.257Z\",\n \"name\": \"consectetur cupidatat nulla sed\",\n \"service_account\": false,\n \"status\": \"ullamco dolore minim\",\n \"title\": \"irure incididunt adipisicing ut\",\n \"verified\": false\n },\n \"id\": \"voluptate aute et irure Excepteur\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1977-12-25T07:31:31.025Z\",\n \"disabled\": false,\n \"email\": \"officia est eu irure ut\",\n \"handle\": \"occaecat\",\n \"icon\": \"ex magna dolore in\",\n \"modified_at\": \"1977-11-14T04:52:53.308Z\",\n \"name\": \"Lo\",\n \"service_account\": false,\n \"status\": \"consectetur in ut\",\n \"title\": \"fugiat aliqua\",\n \"verified\": false\n },\n \"id\": \"ea voluptate nulla dolor\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id"
},
{
"key": "app_key_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id"
},
{
"key": "app_key_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id"
},
{
"key": "app_key_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"00112233-4455-6677-8899-aabbccddeeff\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id"
},
{
"key": "app_key_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete an application key for this service account",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id",
"value": "00000000-0000-1234-0000-000000000000"
},
{
"key": "app_key_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete an application key owned by this service account."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id"
},
{
"key": "app_key_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id"
},
{
"key": "app_key_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id"
},
{
"key": "app_key_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "service_account_id"
},
{
"key": "app_key_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create an application key for this service account",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys"
],
"variable": [
{
"key": "service_account_id",
"value": "00000000-0000-1234-0000-000000000000"
}
]
},
"description": "Create an application key for this service account."
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys"
],
"variable": [
{
"key": "service_account_id"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"key\": \"et ad cillum t\",\n \"last4\": \"abcd\",\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"minim in ipsum mollit\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"2023-03-27T01:31:32.607Z\",\n \"disabled\": true,\n \"email\": \"in\",\n \"handle\": \"anim nostrud voluptate esse\",\n \"icon\": \"quis ea\",\n \"modified_at\": \"1977-03-03T23:21:21.295Z\",\n \"name\": \"eu dolore labore Duis nisi\",\n \"service_account\": false,\n \"status\": \"exercitation dolor Excepteur\",\n \"title\": \"in enim esse quis consectetur\",\n \"verified\": false\n },\n \"id\": \"est cupidatat mollit velit\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1944-12-10T14:07:03.278Z\",\n \"disabled\": false,\n \"email\": \"sed aliqua\",\n \"handle\": \"voluptate adipisicing dolor tempor\",\n \"icon\": \"cillum do mollit\",\n \"modified_at\": \"1983-07-06T02:46:58.072Z\",\n \"name\": \"culpa est\",\n \"service_account\": false,\n \"status\": \"eiusmod do\",\n \"title\": \"nulla magna proident\",\n \"verified\": false\n },\n \"id\": \"proident nisi occaecat\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys"
],
"variable": [
{
"key": "service_account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys"
],
"variable": [
{
"key": "service_account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys"
],
"variable": [
{
"key": "service_account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List application keys for this service account",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
}
],
"variable": [
{
"key": "service_account_id",
"value": "00000000-0000-1234-0000-000000000000"
}
]
},
"description": "List all application keys available for this service account."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
}
],
"variable": [
{
"key": "service_account_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"last4\": \"abcd\",\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"nostrud\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2020-11-23T10:00:00.000Z\",\n \"last4\": \"abcd\",\n \"name\": \"Application Key for managing dashboards\",\n \"scopes\": [\n \"dashboards_read\",\n \"dashboards_write\",\n \"dashboards_public_share\"\n ]\n },\n \"id\": \"magna ut\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1961-12-26T09:33:04.908Z\",\n \"disabled\": false,\n \"email\": \"eu ut dolore aute\",\n \"handle\": \"sunt anim veniam fugiat\",\n \"icon\": \"sunt fugiat Lorem adipisicing sit\",\n \"modified_at\": \"2010-02-06T08:06:38.022Z\",\n \"name\": \"mollit reprehenderit dolor cupidatat\",\n \"service_account\": false,\n \"status\": \"incididunt esse\",\n \"title\": \"sed officia pariatur\",\n \"verified\": true\n },\n \"id\": \"reprehenderit cillum adipisi\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1983-11-29T18:09:08.094Z\",\n \"disabled\": false,\n \"email\": \"Duis\",\n \"handle\": \"sunt ut do\",\n \"icon\": \"velit sit\",\n \"modified_at\": \"1951-11-07T11:04:55.182Z\",\n \"name\": \"qui labore\",\n \"service_account\": true,\n \"status\": \"id aute velit dolor\",\n \"title\": \"et Excepteur\",\n \"verified\": true\n },\n \"id\": \"in amet qui aute\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ],\n \"meta\": {\n \"max_allowed_per_user\": -38029116,\n \"page\": {\n \"total_filtered_count\": 22366699\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
}
],
"variable": [
{
"key": "service_account_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
}
],
"variable": [
{
"key": "service_account_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
}
],
"variable": [
{
"key": "service_account_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "Application key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter application keys by the specified string.",
"disabled": true
},
{
"key": "filter[created_at][start]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or after the specified date.",
"disabled": true
},
{
"key": "filter[created_at][end]",
"value": "2020-11-24T18:46:21+00:00",
"description": "Only include application keys created on or before the specified date.",
"disabled": true
}
],
"variable": [
{
"key": "service_account_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Create, edit, and disable service accounts. See the [Service Accounts page](https://docs.datadoghq.com/account_management/org_settings/service_accounts/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Service Checks",
"item": [
{
"name": "Submit a Service Check",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "text/json"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"check\": \"app.ok\",\n \"status\": 0,\n \"tags\": [\n \"environment:test\"\n ],\n \"host_name\": \"app.host1\",\n \"message\": \"app is running\",\n \"timestamp\": -54803726\n },\n {\n \"check\": \"app.ok\",\n \"status\": 0,\n \"tags\": [\n \"environment:test\"\n ],\n \"host_name\": \"app.host1\",\n \"message\": \"app is running\",\n \"timestamp\": 16507355\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/check_run",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"check_run"
]
},
"description": "Submit a list of Service Checks.\n\n**Notes**:\n- A valid API key is required.\n- Service checks can be submitted up to 10 minutes in the past."
},
"response": [
{
"name": "Payload accepted",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "text/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"check\": \"app.ok\",\n \"status\": 0,\n \"tags\": [\n \"environment:test\"\n ],\n \"host_name\": \"app.host1\",\n \"message\": \"app is running\",\n \"timestamp\": -54803726\n },\n {\n \"check\": \"app.ok\",\n \"status\": 0,\n \"tags\": [\n \"environment:test\"\n ],\n \"host_name\": \"app.host1\",\n \"message\": \"app is running\",\n \"timestamp\": 16507355\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/check_run",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"check_run"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/json"
}
],
"cookie": [],
"body": "{\n \"status\": \"ok\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "text/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"check\": \"app.ok\",\n \"status\": 0,\n \"tags\": [\n \"environment:test\"\n ],\n \"host_name\": \"app.host1\",\n \"message\": \"app is running\",\n \"timestamp\": -54803726\n },\n {\n \"check\": \"app.ok\",\n \"status\": 0,\n \"tags\": [\n \"environment:test\"\n ],\n \"host_name\": \"app.host1\",\n \"message\": \"app is running\",\n \"timestamp\": 16507355\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/check_run",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"check_run"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "text/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"check\": \"app.ok\",\n \"status\": 0,\n \"tags\": [\n \"environment:test\"\n ],\n \"host_name\": \"app.host1\",\n \"message\": \"app is running\",\n \"timestamp\": -54803726\n },\n {\n \"check\": \"app.ok\",\n \"status\": 0,\n \"tags\": [\n \"environment:test\"\n ],\n \"host_name\": \"app.host1\",\n \"message\": \"app is running\",\n \"timestamp\": 16507355\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/check_run",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"check_run"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Request timeout",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "text/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"check\": \"app.ok\",\n \"status\": 0,\n \"tags\": [\n \"environment:test\"\n ],\n \"host_name\": \"app.host1\",\n \"message\": \"app is running\",\n \"timestamp\": -54803726\n },\n {\n \"check\": \"app.ok\",\n \"status\": 0,\n \"tags\": [\n \"environment:test\"\n ],\n \"host_name\": \"app.host1\",\n \"message\": \"app is running\",\n \"timestamp\": 16507355\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/check_run",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"check_run"
]
}
},
"status": "Request Timeout",
"code": 408,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Payload too large",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "text/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"check\": \"app.ok\",\n \"status\": 0,\n \"tags\": [\n \"environment:test\"\n ],\n \"host_name\": \"app.host1\",\n \"message\": \"app is running\",\n \"timestamp\": -54803726\n },\n {\n \"check\": \"app.ok\",\n \"status\": 0,\n \"tags\": [\n \"environment:test\"\n ],\n \"host_name\": \"app.host1\",\n \"message\": \"app is running\",\n \"timestamp\": 16507355\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/check_run",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"check_run"
]
}
},
"status": "Request Entity Too Large",
"code": 413,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"check\": \"app.ok\",\n \"status\": 0,\n \"tags\": [\n \"environment:test\"\n ],\n \"host_name\": \"app.host1\",\n \"message\": \"app is running\",\n \"timestamp\": -54803726\n },\n {\n \"check\": \"app.ok\",\n \"status\": 0,\n \"tags\": [\n \"environment:test\"\n ],\n \"host_name\": \"app.host1\",\n \"message\": \"app is running\",\n \"timestamp\": 16507355\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/check_run",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"check_run"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "The service check endpoint allows you to post check statuses for use with monitors.\nService check messages are limited to 500 characters. If a check is posted with a message\ncontaining more than 500 characters, only the first 500 characters are displayed. Messages\nare limited for checks with a Critical or Warning status, they are dropped for checks with\nan OK status.\n\n- [Read more about Service Check monitors][1].\n- [Read more about Process Check monitors][2].\n- [Read more about Network monitors][3].\n- [Read more about Custom Check monitors][4].\n- [Read more about Service Checks and status codes][5].\n\n[1]: https://docs.datadoghq.com/monitors/types/service_check/\n[2]: https://docs.datadoghq.com/monitors/create/types/process_check/?tab=checkalert\n[3]: https://docs.datadoghq.com/monitors/create/types/network/?tab=checkalert\n[4]: https://docs.datadoghq.com/monitors/create/types/custom_check/?tab=checkalert\n[5]: https://docs.datadoghq.com/developers/service_checks/",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Service Definition",
"item": [
{
"name": "Get all service definitions",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response.",
"disabled": true
}
]
},
"description": "Get a list of all service definitions from the Datadog Service Catalog."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"meta\": {\n \"github-html-url\": \"esse eiusmod\",\n \"ingested-schema-version\": \"Excepteur esse labore consectetur adipisicing\",\n \"ingestion-source\": \"esse aute quis do ea\",\n \"last-modified-time\": \"ipsum ut\",\n \"origin\": \"cupidatat deserunt exercitation\",\n \"origin-detail\": \"Ut culpa Lo\",\n \"warnings\": [\n {\n \"instance-location\": \"laboris nostrud\",\n \"keyword-location\": \"enim quis commodo voluptate\",\n \"message\": \"qui\"\n },\n {\n \"instance-location\": \"esse qui et dolore quis\",\n \"keyword-location\": \"est tempor sint Lorem\",\n \"message\": \"conse\"\n }\n ]\n },\n \"schema\": {\n \"schema-version\": \"v1\",\n \"info\": {\n \"dd-service\": \"myservice\",\n \"description\": \"A shopping cart service\",\n \"display-name\": \"My Service\",\n \"service-tier\": \"Tier 1\"\n },\n \"contact\": {\n \"email\": \"contact@datadoghq.com\",\n \"slack\": \"https://yourcompany.slack.com/archives/channel123\"\n },\n \"extensions\": {\n \"myorg/extension\": \"extensionValue\"\n },\n \"external-resources\": [\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\"\n },\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\"\n }\n ],\n \"integrations\": {\n \"pagerduty\": \"https://my-org.pagerduty.com/service-directory/PMyService\"\n },\n \"org\": {\n \"application\": \"E-Commerce\",\n \"team\": \"my-team\"\n },\n \"tags\": [\n \"my:tag\",\n \"service:tag\"\n ]\n }\n },\n \"id\": \"elit officia do proident\",\n \"type\": \"sint adipisicing Excepteur laborum\"\n },\n {\n \"attributes\": {\n \"meta\": {\n \"github-html-url\": \"eiusmod Excepteur cupidatat dolor\",\n \"ingested-schema-version\": \"consectetur adipisicing commodo i\",\n \"ingestion-source\": \"velit consectetur ut\",\n \"last-modified-time\": \"cillum sit exercitation\",\n \"origin\": \"pariatur sunt ut id\",\n \"origin-detail\": \"pariatur \",\n \"warnings\": [\n {\n \"instance-location\": \"anim\",\n \"keyword-location\": \"voluptate sit dolore\",\n \"message\": \"et nostrud tempor\"\n },\n {\n \"instance-location\": \"sit adipisicing labore cupidatat\",\n \"keyword-location\": \"ipsum\",\n \"message\": \"Ut do veniam\"\n }\n ]\n },\n \"schema\": {\n \"schema-version\": \"v1\",\n \"info\": {\n \"dd-service\": \"myservice\",\n \"description\": \"A shopping cart service\",\n \"display-name\": \"My Service\",\n \"service-tier\": \"Tier 1\"\n },\n \"contact\": {\n \"email\": \"contact@datadoghq.com\",\n \"slack\": \"https://yourcompany.slack.com/archives/channel123\"\n },\n \"extensions\": {\n \"myorg/extension\": \"extensionValue\"\n },\n \"external-resources\": [\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\"\n },\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\"\n }\n ],\n \"integrations\": {\n \"pagerduty\": \"https://my-org.pagerduty.com/service-directory/PMyService\"\n },\n \"org\": {\n \"application\": \"E-Commerce\",\n \"team\": \"my-team\"\n },\n \"tags\": [\n \"my:tag\",\n \"service:tag\"\n ]\n }\n },\n \"id\": \"qui ea in\",\n \"type\": \"minim et\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create or update service definition",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schema-version\": \"v2.2\",\n \"dd-service\": \"my-service\",\n \"application\": \"my-app\",\n \"ci-pipeline-fingerprints\": [\n \"j88xdEy0J5lc\",\n \"eZ7LMljCk8vo\"\n ],\n \"contacts\": [\n {\n \"type\": \"slack\",\n \"contact\": \"https://teams.microsoft.com/myteam\",\n \"name\": \"My team channel\"\n },\n {\n \"type\": \"slack\",\n \"contact\": \"https://teams.microsoft.com/myteam\",\n \"name\": \"My team channel\"\n }\n ],\n \"description\": \"My service description\",\n \"extensions\": {\n \"myorg/extension\": \"extensionValue\"\n },\n \"integrations\": {\n \"opsgenie\": {\n \"service-url\": \"https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000\",\n \"region\": \"US\"\n },\n \"pagerduty\": {\n \"service-url\": \"https://my-org.pagerduty.com/service-directory/PMyService\"\n }\n },\n \"languages\": [\n \"dotnet\",\n \"go\",\n \"java\",\n \"js\",\n \"php\",\n \"python\",\n \"ruby\",\n \"c++\"\n ],\n \"lifecycle\": \"sandbox\",\n \"links\": [\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\",\n \"provider\": \"Github\"\n },\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\",\n \"provider\": \"Github\"\n }\n ],\n \"tags\": [\n \"my:tag\",\n \"service:tag\"\n ],\n \"team\": \"my-team\",\n \"tier\": \"High\",\n \"type\": \"web\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
]
},
"description": "Create or update service definition in the Datadog Service Catalog."
},
"response": [
{
"name": "CREATED",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schema-version\": \"v2.2\",\n \"dd-service\": \"my-service\",\n \"application\": \"my-app\",\n \"ci-pipeline-fingerprints\": [\n \"j88xdEy0J5lc\",\n \"eZ7LMljCk8vo\"\n ],\n \"contacts\": [\n {\n \"type\": \"slack\",\n \"contact\": \"https://teams.microsoft.com/myteam\",\n \"name\": \"My team channel\"\n },\n {\n \"type\": \"slack\",\n \"contact\": \"https://teams.microsoft.com/myteam\",\n \"name\": \"My team channel\"\n }\n ],\n \"description\": \"My service description\",\n \"extensions\": {\n \"myorg/extension\": \"extensionValue\"\n },\n \"integrations\": {\n \"opsgenie\": {\n \"service-url\": \"https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000\",\n \"region\": \"US\"\n },\n \"pagerduty\": {\n \"service-url\": \"https://my-org.pagerduty.com/service-directory/PMyService\"\n }\n },\n \"languages\": [\n \"dotnet\",\n \"go\",\n \"java\",\n \"js\",\n \"php\",\n \"python\",\n \"ruby\",\n \"c++\"\n ],\n \"lifecycle\": \"sandbox\",\n \"links\": [\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\",\n \"provider\": \"Github\"\n },\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\",\n \"provider\": \"Github\"\n }\n ],\n \"tags\": [\n \"my:tag\",\n \"service:tag\"\n ],\n \"team\": \"my-team\",\n \"tier\": \"High\",\n \"type\": \"web\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"meta\": {\n \"github-html-url\": \"laborum proident ut exercitation reprehenderit\",\n \"ingested-schema-version\": \"velit laboris\",\n \"ingestion-source\": \"enim\",\n \"last-modified-time\": \"adipisicing do amet ipsum\",\n \"origin\": \"do\",\n \"origin-detail\": \"veniam\",\n \"warnings\": [\n {\n \"instance-location\": \"sed nostrud\",\n \"keyword-location\": \"irure consectetur minim\",\n \"message\": \"Ut\"\n },\n {\n \"instance-location\": \"culpa amet ullamco mollit\",\n \"keyword-location\": \"id ea Lorem\",\n \"message\": \"sed sit labore veniam ex\"\n }\n ]\n },\n \"schema\": {\n \"schema-version\": \"v1\",\n \"info\": {\n \"dd-service\": \"myservice\",\n \"description\": \"A shopping cart service\",\n \"display-name\": \"My Service\",\n \"service-tier\": \"Tier 1\"\n },\n \"contact\": {\n \"email\": \"contact@datadoghq.com\",\n \"slack\": \"https://yourcompany.slack.com/archives/channel123\"\n },\n \"extensions\": {\n \"myorg/extension\": \"extensionValue\"\n },\n \"external-resources\": [\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\"\n },\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\"\n }\n ],\n \"integrations\": {\n \"pagerduty\": \"https://my-org.pagerduty.com/service-directory/PMyService\"\n },\n \"org\": {\n \"application\": \"E-Commerce\",\n \"team\": \"my-team\"\n },\n \"tags\": [\n \"my:tag\",\n \"service:tag\"\n ]\n }\n },\n \"id\": \"Ut proident anim\",\n \"type\": \"nostrud commodo\"\n },\n {\n \"attributes\": {\n \"meta\": {\n \"github-html-url\": \"incididunt nostrud sin\",\n \"ingested-schema-version\": \"in\",\n \"ingestion-source\": \"commodo\",\n \"last-modified-time\": \"adipisicing qui e\",\n \"origin\": \"adipisicing\",\n \"origin-detail\": \"Ut proident\",\n \"warnings\": [\n {\n \"instance-location\": \"exercitation ea veniam\",\n \"keyword-location\": \"adipisicing dolore amet\",\n \"message\": \"adipisicing enim sit ut\"\n },\n {\n \"instance-location\": \"dolor Excepteur cillum non\",\n \"keyword-location\": \"elit\",\n \"message\": \"aute in ea est\"\n }\n ]\n },\n \"schema\": {\n \"schema-version\": \"v1\",\n \"info\": {\n \"dd-service\": \"myservice\",\n \"description\": \"A shopping cart service\",\n \"display-name\": \"My Service\",\n \"service-tier\": \"Tier 1\"\n },\n \"contact\": {\n \"email\": \"contact@datadoghq.com\",\n \"slack\": \"https://yourcompany.slack.com/archives/channel123\"\n },\n \"extensions\": {\n \"myorg/extension\": \"extensionValue\"\n },\n \"external-resources\": [\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\"\n },\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\"\n }\n ],\n \"integrations\": {\n \"pagerduty\": \"https://my-org.pagerduty.com/service-directory/PMyService\"\n },\n \"org\": {\n \"application\": \"E-Commerce\",\n \"team\": \"my-team\"\n },\n \"tags\": [\n \"my:tag\",\n \"service:tag\"\n ]\n }\n },\n \"id\": \"dolor quis est ullamco ut\",\n \"type\": \"qui l\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schema-version\": \"v2.2\",\n \"dd-service\": \"my-service\",\n \"application\": \"my-app\",\n \"ci-pipeline-fingerprints\": [\n \"j88xdEy0J5lc\",\n \"eZ7LMljCk8vo\"\n ],\n \"contacts\": [\n {\n \"type\": \"slack\",\n \"contact\": \"https://teams.microsoft.com/myteam\",\n \"name\": \"My team channel\"\n },\n {\n \"type\": \"slack\",\n \"contact\": \"https://teams.microsoft.com/myteam\",\n \"name\": \"My team channel\"\n }\n ],\n \"description\": \"My service description\",\n \"extensions\": {\n \"myorg/extension\": \"extensionValue\"\n },\n \"integrations\": {\n \"opsgenie\": {\n \"service-url\": \"https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000\",\n \"region\": \"US\"\n },\n \"pagerduty\": {\n \"service-url\": \"https://my-org.pagerduty.com/service-directory/PMyService\"\n }\n },\n \"languages\": [\n \"dotnet\",\n \"go\",\n \"java\",\n \"js\",\n \"php\",\n \"python\",\n \"ruby\",\n \"c++\"\n ],\n \"lifecycle\": \"sandbox\",\n \"links\": [\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\",\n \"provider\": \"Github\"\n },\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\",\n \"provider\": \"Github\"\n }\n ],\n \"tags\": [\n \"my:tag\",\n \"service:tag\"\n ],\n \"team\": \"my-team\",\n \"tier\": \"High\",\n \"type\": \"web\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schema-version\": \"v2.2\",\n \"dd-service\": \"my-service\",\n \"application\": \"my-app\",\n \"ci-pipeline-fingerprints\": [\n \"j88xdEy0J5lc\",\n \"eZ7LMljCk8vo\"\n ],\n \"contacts\": [\n {\n \"type\": \"slack\",\n \"contact\": \"https://teams.microsoft.com/myteam\",\n \"name\": \"My team channel\"\n },\n {\n \"type\": \"slack\",\n \"contact\": \"https://teams.microsoft.com/myteam\",\n \"name\": \"My team channel\"\n }\n ],\n \"description\": \"My service description\",\n \"extensions\": {\n \"myorg/extension\": \"extensionValue\"\n },\n \"integrations\": {\n \"opsgenie\": {\n \"service-url\": \"https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000\",\n \"region\": \"US\"\n },\n \"pagerduty\": {\n \"service-url\": \"https://my-org.pagerduty.com/service-directory/PMyService\"\n }\n },\n \"languages\": [\n \"dotnet\",\n \"go\",\n \"java\",\n \"js\",\n \"php\",\n \"python\",\n \"ruby\",\n \"c++\"\n ],\n \"lifecycle\": \"sandbox\",\n \"links\": [\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\",\n \"provider\": \"Github\"\n },\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\",\n \"provider\": \"Github\"\n }\n ],\n \"tags\": [\n \"my:tag\",\n \"service:tag\"\n ],\n \"team\": \"my-team\",\n \"tier\": \"High\",\n \"type\": \"web\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schema-version\": \"v2.2\",\n \"dd-service\": \"my-service\",\n \"application\": \"my-app\",\n \"ci-pipeline-fingerprints\": [\n \"j88xdEy0J5lc\",\n \"eZ7LMljCk8vo\"\n ],\n \"contacts\": [\n {\n \"type\": \"slack\",\n \"contact\": \"https://teams.microsoft.com/myteam\",\n \"name\": \"My team channel\"\n },\n {\n \"type\": \"slack\",\n \"contact\": \"https://teams.microsoft.com/myteam\",\n \"name\": \"My team channel\"\n }\n ],\n \"description\": \"My service description\",\n \"extensions\": {\n \"myorg/extension\": \"extensionValue\"\n },\n \"integrations\": {\n \"opsgenie\": {\n \"service-url\": \"https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000\",\n \"region\": \"US\"\n },\n \"pagerduty\": {\n \"service-url\": \"https://my-org.pagerduty.com/service-directory/PMyService\"\n }\n },\n \"languages\": [\n \"dotnet\",\n \"go\",\n \"java\",\n \"js\",\n \"php\",\n \"python\",\n \"ruby\",\n \"c++\"\n ],\n \"lifecycle\": \"sandbox\",\n \"links\": [\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\",\n \"provider\": \"Github\"\n },\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\",\n \"provider\": \"Github\"\n }\n ],\n \"tags\": [\n \"my:tag\",\n \"service:tag\"\n ],\n \"team\": \"my-team\",\n \"tier\": \"High\",\n \"type\": \"web\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schema-version\": \"v2.2\",\n \"dd-service\": \"my-service\",\n \"application\": \"my-app\",\n \"ci-pipeline-fingerprints\": [\n \"j88xdEy0J5lc\",\n \"eZ7LMljCk8vo\"\n ],\n \"contacts\": [\n {\n \"type\": \"slack\",\n \"contact\": \"https://teams.microsoft.com/myteam\",\n \"name\": \"My team channel\"\n },\n {\n \"type\": \"slack\",\n \"contact\": \"https://teams.microsoft.com/myteam\",\n \"name\": \"My team channel\"\n }\n ],\n \"description\": \"My service description\",\n \"extensions\": {\n \"myorg/extension\": \"extensionValue\"\n },\n \"integrations\": {\n \"opsgenie\": {\n \"service-url\": \"https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000\",\n \"region\": \"US\"\n },\n \"pagerduty\": {\n \"service-url\": \"https://my-org.pagerduty.com/service-directory/PMyService\"\n }\n },\n \"languages\": [\n \"dotnet\",\n \"go\",\n \"java\",\n \"js\",\n \"php\",\n \"python\",\n \"ruby\",\n \"c++\"\n ],\n \"lifecycle\": \"sandbox\",\n \"links\": [\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\",\n \"provider\": \"Github\"\n },\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\",\n \"provider\": \"Github\"\n }\n ],\n \"tags\": [\n \"my:tag\",\n \"service:tag\"\n ],\n \"team\": \"my-team\",\n \"tier\": \"High\",\n \"type\": \"web\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a single service definition",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"query": [
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response.",
"disabled": true
}
],
"variable": [
{
"key": "service_name",
"value": "my-service"
}
]
},
"description": "Get a single service definition from the Datadog Service Catalog."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"query": [
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response.",
"disabled": true
}
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"meta\": {\n \"github-html-url\": \"amet consequat\",\n \"ingested-schema-version\": \"eu qui voluptate quis\",\n \"ingestion-source\": \"ut deserunt\",\n \"last-modified-time\": \"cupidatat\",\n \"origin\": \"veniam ut\",\n \"origin-detail\": \"eu anim\",\n \"warnings\": [\n {\n \"instance-location\": \"et commodo\",\n \"keyword-location\": \"officia dolor nostrud\",\n \"message\": \"sit laboris\"\n },\n {\n \"instance-location\": \"ut sit in elit\",\n \"keyword-location\": \"laborum\",\n \"message\": \"Excepteur pariatur dolor nulla et\"\n }\n ]\n },\n \"schema\": {\n \"schema-version\": \"v1\",\n \"info\": {\n \"dd-service\": \"myservice\",\n \"description\": \"A shopping cart service\",\n \"display-name\": \"My Service\",\n \"service-tier\": \"Tier 1\"\n },\n \"contact\": {\n \"email\": \"contact@datadoghq.com\",\n \"slack\": \"https://yourcompany.slack.com/archives/channel123\"\n },\n \"extensions\": {\n \"myorg/extension\": \"extensionValue\"\n },\n \"external-resources\": [\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\"\n },\n {\n \"name\": \"Runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://my-runbook\"\n }\n ],\n \"integrations\": {\n \"pagerduty\": \"https://my-org.pagerduty.com/service-directory/PMyService\"\n },\n \"org\": {\n \"application\": \"E-Commerce\",\n \"team\": \"my-team\"\n },\n \"tags\": [\n \"my:tag\",\n \"service:tag\"\n ]\n }\n },\n \"id\": \"non\",\n \"type\": \"labore sed\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"query": [
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response.",
"disabled": true
}
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"query": [
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response.",
"disabled": true
}
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"query": [
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response.",
"disabled": true
}
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"query": [
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response.",
"disabled": true
}
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"query": [
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response.",
"disabled": true
}
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a single service definition",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"variable": [
{
"key": "service_name",
"value": "my-service"
}
]
},
"description": "Delete a single service definition in the Datadog Service Catalog."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions/:service_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "API to create, update, retrieve and delete service definitions.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Service Level Objective Corrections",
"item": [
{
"name": "Create an SLO correction",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"correction\",\n \"attributes\": {\n \"slo_id\": \"sloId\",\n \"start\": 1600000000,\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"ex nisi dolor e\",\n \"duration\": 1600000000,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"timezone\": \"UTC\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
]
},
"description": "Create an SLO Correction."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"correction\",\n \"attributes\": {\n \"slo_id\": \"sloId\",\n \"start\": 1600000000,\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"ex nisi dolor e\",\n \"duration\": 1600000000,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"timezone\": \"UTC\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"category\": \"Scheduled Maintenance\",\n \"created_at\": -42445941,\n \"creator\": {\n \"email\": \"esse proident voluptate\",\n \"handle\": \"est sunt\",\n \"name\": \"consequat\"\n },\n \"description\": \"officia dolor cupidatat\",\n \"duration\": 3600,\n \"end\": -21506349,\n \"modified_at\": -30984020,\n \"modifier\": {\n \"email\": \"dolor cupidatat\",\n \"handle\": \"aute laboris irure officia\",\n \"name\": \"consequat\"\n },\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"slo_id\": \"nostrud\",\n \"start\": -28285922,\n \"timezone\": \"in sunt sit non\"\n },\n \"id\": \"Lorem voluptate mollit id\",\n \"type\": \"correction\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"correction\",\n \"attributes\": {\n \"slo_id\": \"sloId\",\n \"start\": 1600000000,\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"ex nisi dolor e\",\n \"duration\": 1600000000,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"timezone\": \"UTC\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"correction\",\n \"attributes\": {\n \"slo_id\": \"sloId\",\n \"start\": 1600000000,\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"ex nisi dolor e\",\n \"duration\": 1600000000,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"timezone\": \"UTC\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "SLO Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"correction\",\n \"attributes\": {\n \"slo_id\": \"sloId\",\n \"start\": 1600000000,\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"ex nisi dolor e\",\n \"duration\": 1600000000,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"timezone\": \"UTC\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"correction\",\n \"attributes\": {\n \"slo_id\": \"sloId\",\n \"start\": 1600000000,\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"ex nisi dolor e\",\n \"duration\": 1600000000,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"timezone\": \"UTC\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all SLO corrections",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
],
"query": [
{
"key": "offset",
"value": "-32260706",
"description": "The specific offset to use as the beginning of the returned response.",
"disabled": true
},
{
"key": "limit",
"value": "25",
"description": "The number of SLO corrections to return in the response. Default is 25.",
"disabled": true
}
]
},
"description": "Get all Service Level Objective corrections."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
],
"query": [
{
"key": "offset",
"value": "-32260706",
"description": "The specific offset to use as the beginning of the returned response.",
"disabled": true
},
{
"key": "limit",
"value": "25",
"description": "The number of SLO corrections to return in the response. Default is 25.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"category\": \"Scheduled Maintenance\",\n \"created_at\": -27032860,\n \"creator\": {\n \"email\": \"enim adipisicing pariatur minim\",\n \"handle\": \"esse quis sed\",\n \"name\": \"dolor cupidatat ea esse\"\n },\n \"description\": \"officia laborum exercitation id elit\",\n \"duration\": 3600,\n \"end\": 61700929,\n \"modified_at\": -75100476,\n \"modifier\": {\n \"email\": \"proident dolor esse deserunt\",\n \"handle\": \"laboris ullamco magna\",\n \"name\": \"ea\"\n },\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"slo_id\": \"Lorem sed\",\n \"start\": 38728658,\n \"timezone\": \"in anim\"\n },\n \"id\": \"Excepteur proident adipisicing\",\n \"type\": \"correction\"\n },\n {\n \"attributes\": {\n \"category\": \"Scheduled Maintenance\",\n \"created_at\": -88094641,\n \"creator\": {\n \"email\": \"laboris sed nisi ut Duis\",\n \"handle\": \"sint aliquip reprehenderit dolore sunt\",\n \"name\": \"nostrud\"\n },\n \"description\": \"nostrud irure minim\",\n \"duration\": 3600,\n \"end\": 85057281,\n \"modified_at\": -25234487,\n \"modifier\": {\n \"email\": \"consectetur consequat culpa\",\n \"handle\": \"Excepteur in nulla quis\",\n \"name\": \"cillum minim\"\n },\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"slo_id\": \"anim\",\n \"start\": 25833725,\n \"timezone\": \"exercitation aliqua\"\n },\n \"id\": \"cillum deserunt in commodo\",\n \"type\": \"correction\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": 65202090,\n \"total_filtered_count\": -82732967\n }\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
],
"query": [
{
"key": "offset",
"value": "-32260706",
"description": "The specific offset to use as the beginning of the returned response.",
"disabled": true
},
{
"key": "limit",
"value": "25",
"description": "The number of SLO corrections to return in the response. Default is 25.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
],
"query": [
{
"key": "offset",
"value": "-32260706",
"description": "The specific offset to use as the beginning of the returned response.",
"disabled": true
},
{
"key": "limit",
"value": "25",
"description": "The number of SLO corrections to return in the response. Default is 25.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get an SLO correction for an SLO",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id",
"value": "pariatur"
}
]
},
"description": "Get an SLO correction."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"category\": \"Scheduled Maintenance\",\n \"created_at\": -42445941,\n \"creator\": {\n \"email\": \"esse proident voluptate\",\n \"handle\": \"est sunt\",\n \"name\": \"consequat\"\n },\n \"description\": \"officia dolor cupidatat\",\n \"duration\": 3600,\n \"end\": -21506349,\n \"modified_at\": -30984020,\n \"modifier\": {\n \"email\": \"dolor cupidatat\",\n \"handle\": \"aute laboris irure officia\",\n \"name\": \"consequat\"\n },\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"slo_id\": \"nostrud\",\n \"start\": -28285922,\n \"timezone\": \"in sunt sit non\"\n },\n \"id\": \"Lorem voluptate mollit id\",\n \"type\": \"correction\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update an SLO correction",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"Ut incididunt\",\n \"duration\": 3600,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"start\": 1600000000,\n \"timezone\": \"UTC\"\n },\n \"type\": \"correction\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id",
"value": "pariatur"
}
]
},
"description": "Update the specified SLO correction object."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"Ut incididunt\",\n \"duration\": 3600,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"start\": 1600000000,\n \"timezone\": \"UTC\"\n },\n \"type\": \"correction\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"category\": \"Scheduled Maintenance\",\n \"created_at\": -42445941,\n \"creator\": {\n \"email\": \"esse proident voluptate\",\n \"handle\": \"est sunt\",\n \"name\": \"consequat\"\n },\n \"description\": \"officia dolor cupidatat\",\n \"duration\": 3600,\n \"end\": -21506349,\n \"modified_at\": -30984020,\n \"modifier\": {\n \"email\": \"dolor cupidatat\",\n \"handle\": \"aute laboris irure officia\",\n \"name\": \"consequat\"\n },\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"slo_id\": \"nostrud\",\n \"start\": -28285922,\n \"timezone\": \"in sunt sit non\"\n },\n \"id\": \"Lorem voluptate mollit id\",\n \"type\": \"correction\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"Ut incididunt\",\n \"duration\": 3600,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"start\": 1600000000,\n \"timezone\": \"UTC\"\n },\n \"type\": \"correction\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"Ut incididunt\",\n \"duration\": 3600,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"start\": 1600000000,\n \"timezone\": \"UTC\"\n },\n \"type\": \"correction\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"Ut incididunt\",\n \"duration\": 3600,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"start\": 1600000000,\n \"timezone\": \"UTC\"\n },\n \"type\": \"correction\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"Ut incididunt\",\n \"duration\": 3600,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"start\": 1600000000,\n \"timezone\": \"UTC\"\n },\n \"type\": \"correction\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete an SLO correction",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id",
"value": "pariatur"
}
]
},
"description": "Permanently delete the specified SLO correction object."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction/:slo_correction_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction",
":slo_correction_id"
],
"variable": [
{
"key": "slo_correction_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "SLO Status Corrections allow you to prevent specific time periods from negatively impacting\nyour SLO’s status and error budget. You can use Status Corrections for various purposes, such\nas removing planned maintenance windows, non-business hours, or other time periods that do\nnot correspond to genuine issues. See [SLO status corrections](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-status-corrections) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Service Level Objectives",
"item": [
{
"name": "Create an SLO object",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"description\": \"ea Duis sunt velit amet\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"monitor_ids\": [\n -87227150,\n -82478264\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
]
},
"description": "Create a service level objective object."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"description\": \"ea Duis sunt velit amet\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"monitor_ids\": [\n -87227150,\n -82478264\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"created_at\": -65283953,\n \"creator\": {\n \"email\": \"irure aliqua tem\",\n \"handle\": \"fugiat \",\n \"name\": \"labore officia\"\n },\n \"description\": \"ea\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"id\": \"exercitation esse anim\",\n \"modified_at\": 49740788,\n \"monitor_ids\": [\n -79804514,\n -61079246\n ],\n \"monitor_tags\": [\n \"do fugiat dolore ipsum\",\n \"eu pariatur do nulla\"\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n },\n {\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"created_at\": 74831822,\n \"creator\": {\n \"email\": \"Excepteur ut mollit do\",\n \"handle\": \"mollit offic\",\n \"name\": \"esse non sit sed\"\n },\n \"description\": \"non ut irure occaecat Excepteur\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"id\": \"ipsum enim\",\n \"modified_at\": 37773724,\n \"monitor_ids\": [\n -50893227,\n 91148165\n ],\n \"monitor_tags\": [\n \"dolor ut reprehenderit eiusmod\",\n \"dolor ani\"\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n }\n ],\n \"errors\": [\n \"dolor\",\n \"consequat mollit pariatur dolor\"\n ],\n \"metadata\": {\n \"page\": {\n \"total_count\": -48143109,\n \"total_filtered_count\": 40213587\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"description\": \"ea Duis sunt velit amet\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"monitor_ids\": [\n -87227150,\n -82478264\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"description\": \"ea Duis sunt velit amet\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"monitor_ids\": [\n -87227150,\n -82478264\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"description\": \"ea Duis sunt velit amet\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"monitor_ids\": [\n -87227150,\n -82478264\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Search for SLOs",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/search?query=exercitation consequat&page[size]=74288761&page[number]=74288761&include_facets=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"search"
],
"query": [
{
"key": "query",
"value": "exercitation consequat",
"description": "The query string to filter results based on SLO names.\nSome examples of queries include `service:<service-name>`\nand `<slo-name>`."
},
{
"key": "page[size]",
"value": "74288761",
"description": "The number of files to return in the response `[default=10]`."
},
{
"key": "page[number]",
"value": "74288761",
"description": "The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`."
},
{
"key": "include_facets",
"value": "true",
"description": "Whether or not to return facet information in the response `[default=false]`."
}
]
},
"description": "Get a list of service level objective objects for your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/search?query=exercitation consequat&page[size]=74288761&page[number]=74288761&include_facets=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"search"
],
"query": [
{
"key": "query",
"value": "exercitation consequat",
"description": "The query string to filter results based on SLO names.\nSome examples of queries include `service:<service-name>`\nand `<slo-name>`."
},
{
"key": "page[size]",
"value": "74288761",
"description": "The number of files to return in the response `[default=10]`."
},
{
"key": "page[number]",
"value": "74288761",
"description": "The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`."
},
{
"key": "include_facets",
"value": "true",
"description": "Whether or not to return facet information in the response `[default=false]`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"facets\": {\n \"all_tags\": [\n {\n \"count\": -69822659,\n \"name\": \"in ut est pariatur\"\n },\n {\n \"count\": 67457798,\n \"name\": \"eiusmod in nisi anim\"\n }\n ],\n \"creator_name\": [\n {\n \"count\": 56911086,\n \"name\": \"culpa\"\n },\n {\n \"count\": 84002238,\n \"name\": \"deserunt commo\"\n }\n ],\n \"env_tags\": [\n {\n \"count\": -81316912,\n \"name\": \"consectetur\"\n },\n {\n \"count\": 23312871,\n \"name\": \"proident in tempor labore\"\n }\n ],\n \"service_tags\": [\n {\n \"count\": 37206862,\n \"name\": \"et ex dolore\"\n },\n {\n \"count\": 72479271,\n \"name\": \"ad cillum do\"\n }\n ],\n \"slo_type\": [\n {\n \"count\": -1310365,\n \"name\": -93003560.89632805\n },\n {\n \"count\": -55494619,\n \"name\": 35654175.73565325\n }\n ],\n \"target\": [\n {\n \"count\": 99529022,\n \"name\": 44248085.05196881\n },\n {\n \"count\": -53775666,\n \"name\": -37674031.5445514\n }\n ],\n \"team_tags\": [\n {\n \"count\": -97739029,\n \"name\": \"reprehenderit \"\n },\n {\n \"count\": -8996443,\n \"name\": \"reprehenderit veniam\"\n }\n ],\n \"timeframe\": [\n {\n \"count\": -53710484,\n \"name\": \"Duis laboris quis ea\"\n },\n {\n \"count\": -30523094,\n \"name\": \"velit ad pariatur aliquip\"\n }\n ]\n },\n \"slos\": [\n {\n \"data\": {\n \"attributes\": {\n \"all_tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"created_at\": 22319053,\n \"creator\": {\n \"email\": \"in ea enim labore\",\n \"id\": 37042979,\n \"name\": \"tempor\"\n },\n \"description\": \"ut et\",\n \"env_tags\": [\n \"non\",\n \"nisi dolore deserunt\"\n ],\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"modified_at\": -78961869,\n \"monitor_ids\": [\n 35645776,\n 57589705\n ],\n \"name\": \"Custom Metric SLO\",\n \"overall_status\": [\n {\n \"error\": \"in fugiat\",\n \"error_budget_remaining\": 100,\n \"indexed_at\": 1662496260,\n \"raw_error_budget_remaining\": {\n \"unit\": \"requests\",\n \"value\": 60\n },\n \"span_precision\": 2,\n \"state\": \"ok\",\n \"status\": 100,\n \"target\": 99,\n \"timeframe\": \"30d\"\n },\n {\n \"error\": \"consequat ipsum Ut cu\",\n \"error_budget_remaining\": 100,\n \"indexed_at\": 1662496260,\n \"raw_error_budget_remaining\": {\n \"unit\": \"requests\",\n \"value\": 60\n },\n \"span_precision\": 2,\n \"state\": \"ok\",\n \"status\": 100,\n \"target\": 99,\n \"timeframe\": \"30d\"\n }\n ],\n \"query\": {\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\",\n \"metrics\": [\n \"my.custom.metric\",\n \"my.other.custom.metric\"\n ],\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\"\n },\n \"service_tags\": [\n \"nulla sed ut tempor\",\n \"aute labore\"\n ],\n \"slo_type\": \"metric\",\n \"status\": {\n \"calculation_error\": \"ex sit laborum et\",\n \"error_budget_remaining\": 100,\n \"indexed_at\": 1662496260,\n \"raw_error_budget_remaining\": {\n \"unit\": \"requests\",\n \"value\": 60\n },\n \"sli\": 100,\n \"span_precision\": 2,\n \"state\": \"ok\"\n },\n \"team_tags\": [\n \"exercitation eu\",\n \"consectetur n\"\n ],\n \"thresholds\": [\n {\n \"target\": 95,\n \"target_display\": \"95\",\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"target_display\": \"95\",\n \"timeframe\": \"30d\",\n \"warning\": 97,\n \"warning_display\": \"97\"\n }\n ]\n },\n \"id\": \"pariatur in Ut labore\",\n \"type\": \"dolor veniam\"\n }\n },\n {\n \"data\": {\n \"attributes\": {\n \"all_tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"created_at\": -74830197,\n \"creator\": {\n \"email\": \"voluptate\",\n \"id\": 89774880,\n \"name\": \"aliquip do velit laboris\"\n },\n \"description\": \"Excepteur ea in pariatur\",\n \"env_tags\": [\n \"exercitation commodo\",\n \"ut\"\n ],\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"modified_at\": 33011084,\n \"monitor_ids\": [\n -88670842,\n -89887942\n ],\n \"name\": \"Custom Metric SLO\",\n \"overall_status\": [\n {\n \"error\": \"elit labore sint\",\n \"error_budget_remaining\": 100,\n \"indexed_at\": 1662496260,\n \"raw_error_budget_remaining\": {\n \"unit\": \"requests\",\n \"value\": 60\n },\n \"span_precision\": 2,\n \"state\": \"ok\",\n \"status\": 100,\n \"target\": 99,\n \"timeframe\": \"30d\"\n },\n {\n \"error\": \"minim velit\",\n \"error_budget_remaining\": 100,\n \"indexed_at\": 1662496260,\n \"raw_error_budget_remaining\": {\n \"unit\": \"requests\",\n \"value\": 60\n },\n \"span_precision\": 2,\n \"state\": \"ok\",\n \"status\": 100,\n \"target\": 99,\n \"timeframe\": \"30d\"\n }\n ],\n \"query\": {\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\",\n \"metrics\": [\n \"my.custom.metric\",\n \"my.other.custom.metric\"\n ],\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\"\n },\n \"service_tags\": [\n \"sit enim\",\n \"cil\"\n ],\n \"slo_type\": \"metric\",\n \"status\": {\n \"calculation_error\": \"Duis \",\n \"error_budget_remaining\": 100,\n \"indexed_at\": 1662496260,\n \"raw_error_budget_remaining\": {\n \"unit\": \"requests\",\n \"value\": 60\n },\n \"sli\": 100,\n \"span_precision\": 2,\n \"state\": \"ok\"\n },\n \"team_tags\": [\n \"est sint Duis pariatur occaecat\",\n \"aliquip sunt\"\n ],\n \"thresholds\": [\n {\n \"target\": 95,\n \"target_display\": \"95\",\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"target_display\": \"95\",\n \"timeframe\": \"30d\",\n \"warning\": 97,\n \"warning_display\": \"97\"\n }\n ]\n },\n \"id\": \"cillum laborum in consectetur\",\n \"type\": \"ullamco exercitation pariatur nulla\"\n }\n }\n ]\n },\n \"type\": \"\"\n },\n \"links\": {\n \"first\": \"esse labore\",\n \"last\": \"incididunt Lorem elit\",\n \"next\": \"dolo\",\n \"prev\": \"reprehenderit\",\n \"self\": \"ex\"\n },\n \"meta\": {\n \"pagination\": {\n \"first_number\": -43885218,\n \"last_number\": -63394160,\n \"next_number\": -94328671,\n \"number\": -17760693,\n \"prev_number\": -93907573,\n \"size\": -51783737,\n \"total\": 69176829,\n \"type\": \"cillum qui dolor\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/search?query=exercitation consequat&page[size]=74288761&page[number]=74288761&include_facets=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"search"
],
"query": [
{
"key": "query",
"value": "exercitation consequat",
"description": "The query string to filter results based on SLO names.\nSome examples of queries include `service:<service-name>`\nand `<slo-name>`."
},
{
"key": "page[size]",
"value": "74288761",
"description": "The number of files to return in the response `[default=10]`."
},
{
"key": "page[number]",
"value": "74288761",
"description": "The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`."
},
{
"key": "include_facets",
"value": "true",
"description": "Whether or not to return facet information in the response `[default=false]`."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/search?query=exercitation consequat&page[size]=74288761&page[number]=74288761&include_facets=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"search"
],
"query": [
{
"key": "query",
"value": "exercitation consequat",
"description": "The query string to filter results based on SLO names.\nSome examples of queries include `service:<service-name>`\nand `<slo-name>`."
},
{
"key": "page[size]",
"value": "74288761",
"description": "The number of files to return in the response `[default=10]`."
},
{
"key": "page[number]",
"value": "74288761",
"description": "The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`."
},
{
"key": "include_facets",
"value": "true",
"description": "Whether or not to return facet information in the response `[default=false]`."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/search?query=exercitation consequat&page[size]=74288761&page[number]=74288761&include_facets=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"search"
],
"query": [
{
"key": "query",
"value": "exercitation consequat",
"description": "The query string to filter results based on SLO names.\nSome examples of queries include `service:<service-name>`\nand `<slo-name>`."
},
{
"key": "page[size]",
"value": "74288761",
"description": "The number of files to return in the response `[default=10]`."
},
{
"key": "page[number]",
"value": "74288761",
"description": "The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`."
},
{
"key": "include_facets",
"value": "true",
"description": "Whether or not to return facet information in the response `[default=false]`."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all SLOs",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo?ids=id1, id2, id3&query=monitor&tags_query=env:prod&metrics_query=aws.elb.request_count&limit=1000&offset=74288761",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "A comma separated list of the IDs of the service level objectives objects."
},
{
"key": "query",
"value": "monitor",
"description": "The query string to filter results based on SLO names."
},
{
"key": "tags_query",
"value": "env:prod",
"description": "The query string to filter results based on a single SLO tag."
},
{
"key": "metrics_query",
"value": "aws.elb.request_count",
"description": "The query string to filter results based on SLO numerator and denominator."
},
{
"key": "limit",
"value": "1000",
"description": "The number of SLOs to return in the response."
},
{
"key": "offset",
"value": "74288761",
"description": "The specific offset to use as the beginning of the returned response."
}
]
},
"description": "Get a list of service level objective objects for your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo?ids=id1, id2, id3&query=monitor&tags_query=env:prod&metrics_query=aws.elb.request_count&limit=1000&offset=74288761",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "A comma separated list of the IDs of the service level objectives objects."
},
{
"key": "query",
"value": "monitor",
"description": "The query string to filter results based on SLO names."
},
{
"key": "tags_query",
"value": "env:prod",
"description": "The query string to filter results based on a single SLO tag."
},
{
"key": "metrics_query",
"value": "aws.elb.request_count",
"description": "The query string to filter results based on SLO numerator and denominator."
},
{
"key": "limit",
"value": "1000",
"description": "The number of SLOs to return in the response."
},
{
"key": "offset",
"value": "74288761",
"description": "The specific offset to use as the beginning of the returned response."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"created_at\": -65283953,\n \"creator\": {\n \"email\": \"irure aliqua tem\",\n \"handle\": \"fugiat \",\n \"name\": \"labore officia\"\n },\n \"description\": \"ea\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"id\": \"exercitation esse anim\",\n \"modified_at\": 49740788,\n \"monitor_ids\": [\n -79804514,\n -61079246\n ],\n \"monitor_tags\": [\n \"do fugiat dolore ipsum\",\n \"eu pariatur do nulla\"\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n },\n {\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"created_at\": 74831822,\n \"creator\": {\n \"email\": \"Excepteur ut mollit do\",\n \"handle\": \"mollit offic\",\n \"name\": \"esse non sit sed\"\n },\n \"description\": \"non ut irure occaecat Excepteur\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"id\": \"ipsum enim\",\n \"modified_at\": 37773724,\n \"monitor_ids\": [\n -50893227,\n 91148165\n ],\n \"monitor_tags\": [\n \"dolor ut reprehenderit eiusmod\",\n \"dolor ani\"\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n }\n ],\n \"errors\": [\n \"dolor\",\n \"consequat mollit pariatur dolor\"\n ],\n \"metadata\": {\n \"page\": {\n \"total_count\": -48143109,\n \"total_filtered_count\": 40213587\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo?ids=id1, id2, id3&query=monitor&tags_query=env:prod&metrics_query=aws.elb.request_count&limit=1000&offset=74288761",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "A comma separated list of the IDs of the service level objectives objects."
},
{
"key": "query",
"value": "monitor",
"description": "The query string to filter results based on SLO names."
},
{
"key": "tags_query",
"value": "env:prod",
"description": "The query string to filter results based on a single SLO tag."
},
{
"key": "metrics_query",
"value": "aws.elb.request_count",
"description": "The query string to filter results based on SLO numerator and denominator."
},
{
"key": "limit",
"value": "1000",
"description": "The number of SLOs to return in the response."
},
{
"key": "offset",
"value": "74288761",
"description": "The specific offset to use as the beginning of the returned response."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo?ids=id1, id2, id3&query=monitor&tags_query=env:prod&metrics_query=aws.elb.request_count&limit=1000&offset=74288761",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "A comma separated list of the IDs of the service level objectives objects."
},
{
"key": "query",
"value": "monitor",
"description": "The query string to filter results based on SLO names."
},
{
"key": "tags_query",
"value": "env:prod",
"description": "The query string to filter results based on a single SLO tag."
},
{
"key": "metrics_query",
"value": "aws.elb.request_count",
"description": "The query string to filter results based on SLO numerator and denominator."
},
{
"key": "limit",
"value": "1000",
"description": "The number of SLOs to return in the response."
},
{
"key": "offset",
"value": "74288761",
"description": "The specific offset to use as the beginning of the returned response."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo?ids=id1, id2, id3&query=monitor&tags_query=env:prod&metrics_query=aws.elb.request_count&limit=1000&offset=74288761",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "A comma separated list of the IDs of the service level objectives objects."
},
{
"key": "query",
"value": "monitor",
"description": "The query string to filter results based on SLO names."
},
{
"key": "tags_query",
"value": "env:prod",
"description": "The query string to filter results based on a single SLO tag."
},
{
"key": "metrics_query",
"value": "aws.elb.request_count",
"description": "The query string to filter results based on SLO numerator and denominator."
},
{
"key": "limit",
"value": "1000",
"description": "The number of SLOs to return in the response."
},
{
"key": "offset",
"value": "74288761",
"description": "The specific offset to use as the beginning of the returned response."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo?ids=id1, id2, id3&query=monitor&tags_query=env:prod&metrics_query=aws.elb.request_count&limit=1000&offset=74288761",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "A comma separated list of the IDs of the service level objectives objects."
},
{
"key": "query",
"value": "monitor",
"description": "The query string to filter results based on SLO names."
},
{
"key": "tags_query",
"value": "env:prod",
"description": "The query string to filter results based on a single SLO tag."
},
{
"key": "metrics_query",
"value": "aws.elb.request_count",
"description": "The query string to filter results based on SLO numerator and denominator."
},
{
"key": "limit",
"value": "1000",
"description": "The number of SLOs to return in the response."
},
{
"key": "offset",
"value": "74288761",
"description": "The specific offset to use as the beginning of the returned response."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update an SLO",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"created_at\": -76984124,\n \"creator\": {\n \"email\": \"sit non velit anim\",\n \"handle\": \"nisi anim consec\",\n \"name\": \"tempor\"\n },\n \"description\": \"mollit\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"id\": \"minim laboris consectetur\",\n \"modified_at\": -49477504,\n \"monitor_ids\": [\n -87196611,\n -69090404\n ],\n \"monitor_tags\": [\n \"dolor velit do aute laboris\",\n \"est dolore\"\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"variable": [
{
"key": "slo_id",
"value": "exercitation consequat"
}
]
},
"description": "Update the specified service level objective object."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"created_at\": -76984124,\n \"creator\": {\n \"email\": \"sit non velit anim\",\n \"handle\": \"nisi anim consec\",\n \"name\": \"tempor\"\n },\n \"description\": \"mollit\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"id\": \"minim laboris consectetur\",\n \"modified_at\": -49477504,\n \"monitor_ids\": [\n -87196611,\n -69090404\n ],\n \"monitor_tags\": [\n \"dolor velit do aute laboris\",\n \"est dolore\"\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"created_at\": -65283953,\n \"creator\": {\n \"email\": \"irure aliqua tem\",\n \"handle\": \"fugiat \",\n \"name\": \"labore officia\"\n },\n \"description\": \"ea\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"id\": \"exercitation esse anim\",\n \"modified_at\": 49740788,\n \"monitor_ids\": [\n -79804514,\n -61079246\n ],\n \"monitor_tags\": [\n \"do fugiat dolore ipsum\",\n \"eu pariatur do nulla\"\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n },\n {\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"created_at\": 74831822,\n \"creator\": {\n \"email\": \"Excepteur ut mollit do\",\n \"handle\": \"mollit offic\",\n \"name\": \"esse non sit sed\"\n },\n \"description\": \"non ut irure occaecat Excepteur\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"id\": \"ipsum enim\",\n \"modified_at\": 37773724,\n \"monitor_ids\": [\n -50893227,\n 91148165\n ],\n \"monitor_tags\": [\n \"dolor ut reprehenderit eiusmod\",\n \"dolor ani\"\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n }\n ],\n \"errors\": [\n \"dolor\",\n \"consequat mollit pariatur dolor\"\n ],\n \"metadata\": {\n \"page\": {\n \"total_count\": -48143109,\n \"total_filtered_count\": 40213587\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"created_at\": -76984124,\n \"creator\": {\n \"email\": \"sit non velit anim\",\n \"handle\": \"nisi anim consec\",\n \"name\": \"tempor\"\n },\n \"description\": \"mollit\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"id\": \"minim laboris consectetur\",\n \"modified_at\": -49477504,\n \"monitor_ids\": [\n -87196611,\n -69090404\n ],\n \"monitor_tags\": [\n \"dolor velit do aute laboris\",\n \"est dolore\"\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"created_at\": -76984124,\n \"creator\": {\n \"email\": \"sit non velit anim\",\n \"handle\": \"nisi anim consec\",\n \"name\": \"tempor\"\n },\n \"description\": \"mollit\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"id\": \"minim laboris consectetur\",\n \"modified_at\": -49477504,\n \"monitor_ids\": [\n -87196611,\n -69090404\n ],\n \"monitor_tags\": [\n \"dolor velit do aute laboris\",\n \"est dolore\"\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"created_at\": -76984124,\n \"creator\": {\n \"email\": \"sit non velit anim\",\n \"handle\": \"nisi anim consec\",\n \"name\": \"tempor\"\n },\n \"description\": \"mollit\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"id\": \"minim laboris consectetur\",\n \"modified_at\": -49477504,\n \"monitor_ids\": [\n -87196611,\n -69090404\n ],\n \"monitor_tags\": [\n \"dolor velit do aute laboris\",\n \"est dolore\"\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"created_at\": -76984124,\n \"creator\": {\n \"email\": \"sit non velit anim\",\n \"handle\": \"nisi anim consec\",\n \"name\": \"tempor\"\n },\n \"description\": \"mollit\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"id\": \"minim laboris consectetur\",\n \"modified_at\": -49477504,\n \"monitor_ids\": [\n -87196611,\n -69090404\n ],\n \"monitor_tags\": [\n \"dolor velit do aute laboris\",\n \"est dolore\"\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get an SLO's details",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id?with_configured_alert_ids=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"query": [
{
"key": "with_configured_alert_ids",
"value": "true",
"description": "Get the IDs of SLO monitors that reference this SLO."
}
],
"variable": [
{
"key": "slo_id",
"value": "exercitation consequat"
}
]
},
"description": "Get a service level objective object."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id?with_configured_alert_ids=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"query": [
{
"key": "with_configured_alert_ids",
"value": "true",
"description": "Get the IDs of SLO monitors that reference this SLO."
}
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"configured_alert_ids\": [\n 123,\n 456,\n 789\n ],\n \"created_at\": -84452746,\n \"creator\": {\n \"email\": \"ipsum dolore\",\n \"handle\": \"pariatur aliqua aute\",\n \"name\": \"ea eiusmod labore culpa\"\n },\n \"description\": \"esse aute consectetur\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"id\": \"in\",\n \"modified_at\": 30535409,\n \"monitor_ids\": [\n -72840808,\n -50318300\n ],\n \"monitor_tags\": [\n \"veniam laborum minim adipisicing\",\n \"voluptate nu\"\n ],\n \"name\": \"Custom Metric SLO\",\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"sli_specification\": {\n \"time_slice\": {\n \"comparator\": \"<\",\n \"query\": {\n \"formulas\": [\n {\n \"formula\": \"query2/query1\"\n }\n ],\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.hits{*} by {env}.as_count()\"\n },\n {\n \"data_source\": \"metrics\",\n \"name\": \"query1\",\n \"query\": \"sum:trace.servlet.request.errors{*} by {env}.as_count()\"\n }\n ]\n },\n \"threshold\": 5\n }\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"timeframe\": \"30d\",\n \"type\": \"metric\",\n \"warning_threshold\": 99.95\n },\n \"errors\": [\n \"sed voluptate amet ex\",\n \"adipisicing fugiat irure voluptate anim\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id?with_configured_alert_ids=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"query": [
{
"key": "with_configured_alert_ids",
"value": "true",
"description": "Get the IDs of SLO monitors that reference this SLO."
}
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id?with_configured_alert_ids=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"query": [
{
"key": "with_configured_alert_ids",
"value": "true",
"description": "Get the IDs of SLO monitors that reference this SLO."
}
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id?with_configured_alert_ids=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"query": [
{
"key": "with_configured_alert_ids",
"value": "true",
"description": "Get the IDs of SLO monitors that reference this SLO."
}
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete an SLO",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id?force=exercitation consequat",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"query": [
{
"key": "force",
"value": "exercitation consequat",
"description": "Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor)."
}
],
"variable": [
{
"key": "slo_id",
"value": "exercitation consequat"
}
]
},
"description": "Permanently delete the specified service level objective object.\n\nIf an SLO is used in a dashboard, the `DELETE /v1/slo/` endpoint returns\na 409 conflict error because the SLO is referenced in a dashboard."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id?force=exercitation consequat",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"query": [
{
"key": "force",
"value": "exercitation consequat",
"description": "Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor)."
}
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n \"ea cupidatat sit\",\n \"et\"\n ],\n \"errors\": {\n \"aliquipa\": \"magna mollit in non\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id?force=exercitation consequat",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"query": [
{
"key": "force",
"value": "exercitation consequat",
"description": "Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor)."
}
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id?force=exercitation consequat",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"query": [
{
"key": "force",
"value": "exercitation consequat",
"description": "Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor)."
}
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id?force=exercitation consequat",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"query": [
{
"key": "force",
"value": "exercitation consequat",
"description": "Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor)."
}
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n \"ea cupidatat sit\",\n \"et\"\n ],\n \"errors\": {\n \"aliquipa\": \"magna mollit in non\"\n }\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id?force=exercitation consequat",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id"
],
"query": [
{
"key": "force",
"value": "exercitation consequat",
"description": "Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor)."
}
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get an SLO's history",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id/history?from_ts=74288761&to_ts=74288761&target=81.04101124863735&apply_correction=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id",
"history"
],
"query": [
{
"key": "from_ts",
"value": "74288761",
"description": "(Required) The `from` timestamp for the query window in epoch seconds."
},
{
"key": "to_ts",
"value": "74288761",
"description": "(Required) The `to` timestamp for the query window in epoch seconds."
},
{
"key": "target",
"value": "81.04101124863735",
"description": "The SLO target. If `target` is passed in, the response will include the remaining error budget and a timeframe value of `custom`."
},
{
"key": "apply_correction",
"value": "true",
"description": "Defaults to `true`. If any SLO corrections are applied and this parameter is set to `false`,\nthen the corrections will not be applied and the SLI values will not be affected."
}
],
"variable": [
{
"key": "slo_id",
"value": "exercitation consequat"
}
]
},
"description": "Get a specific SLO’s history, regardless of its SLO type.\n\nThe detailed history data is structured according to the source data type.\nFor example, metric data is included for event SLOs that use\nthe metric source, and monitor SLO types include the monitor transition history.\n\n**Note:** There are different response formats for event based and time based SLOs.\nExamples of both are shown."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id/history?from_ts=74288761&to_ts=74288761&target=81.04101124863735&apply_correction=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id",
"history"
],
"query": [
{
"key": "from_ts",
"value": "74288761",
"description": "(Required) The `from` timestamp for the query window in epoch seconds."
},
{
"key": "to_ts",
"value": "74288761",
"description": "(Required) The `to` timestamp for the query window in epoch seconds."
},
{
"key": "target",
"value": "81.04101124863735",
"description": "The SLO target. If `target` is passed in, the response will include the remaining error budget and a timeframe value of `custom`."
},
{
"key": "apply_correction",
"value": "true",
"description": "Defaults to `true`. If any SLO corrections are applied and this parameter is set to `false`,\nthen the corrections will not be applied and the SLI values will not be affected."
}
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"from_ts\": 1615323990,\n \"group_by\": [\n \"adipisicing in velit eiusmod\",\n \"eiusmod irure \"\n ],\n \"groups\": [\n {\n \"error_budget_remaining\": {\n \"7d\": 100\n },\n \"errors\": [\n {\n \"error_type\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_type\": \"\",\n \"error_message\": \"\"\n }\n ],\n \"group\": \"name\",\n \"history\": [\n [\n 1579212382,\n 0\n ]\n ],\n \"monitor_modified\": 1615867200,\n \"monitor_type\": \"string\",\n \"name\": \"string\",\n \"preview\": true,\n \"sli_value\": 99.99,\n \"span_precision\": 2\n },\n {\n \"error_budget_remaining\": {\n \"7d\": 100\n },\n \"errors\": [\n {\n \"error_type\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_type\": \"\",\n \"error_message\": \"\"\n }\n ],\n \"group\": \"name\",\n \"history\": [\n [\n 1579212382,\n 0\n ]\n ],\n \"monitor_modified\": 1615867200,\n \"monitor_type\": \"string\",\n \"name\": \"string\",\n \"preview\": true,\n \"sli_value\": 99.99,\n \"span_precision\": 2\n }\n ],\n \"monitors\": [\n {\n \"error_budget_remaining\": {\n \"7d\": 100\n },\n \"errors\": [\n {\n \"error_type\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_type\": \"\",\n \"error_message\": \"\"\n }\n ],\n \"group\": \"name\",\n \"history\": [\n [\n 1579212382,\n 0\n ]\n ],\n \"monitor_modified\": 1615867200,\n \"monitor_type\": \"string\",\n \"name\": \"string\",\n \"preview\": true,\n \"sli_value\": 99.99,\n \"span_precision\": 2\n },\n {\n \"error_budget_remaining\": {\n \"7d\": 100\n },\n \"errors\": [\n {\n \"error_type\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_type\": \"\",\n \"error_message\": \"\"\n }\n ],\n \"group\": \"name\",\n \"history\": [\n [\n 1579212382,\n 0\n ]\n ],\n \"monitor_modified\": 1615867200,\n \"monitor_type\": \"string\",\n \"name\": \"string\",\n \"preview\": true,\n \"sli_value\": 99.99,\n \"span_precision\": 2\n }\n ],\n \"overall\": {\n \"error_budget_remaining\": {\n \"7d\": 100\n },\n \"errors\": [\n {\n \"error_type\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_type\": \"\",\n \"error_message\": \"\"\n }\n ],\n \"group\": \"name\",\n \"history\": [\n [\n 1579212382,\n 0\n ]\n ],\n \"monitor_modified\": 1615867200,\n \"monitor_type\": \"string\",\n \"name\": \"string\",\n \"precision\": {\n \"30d\": 1,\n \"7d\": 2\n },\n \"preview\": true,\n \"sli_value\": 99.99,\n \"span_precision\": 2\n },\n \"series\": {\n \"res_type\": \"\",\n \"interval\": 0,\n \"resp_version\": 0,\n \"query\": \"\",\n \"times\": [],\n \"numerator\": {\n \"count\": 0,\n \"sum\": 0,\n \"metadata\": {}\n },\n \"denominator\": {\n \"count\": 0,\n \"sum\": 0,\n \"metadata\": {}\n },\n \"message\": \"\"\n },\n \"thresholds\": {\n \"my_service\": {\n \"target\": 95,\n \"timeframe\": \"7d\"\n }\n },\n \"to_ts\": 1615928790,\n \"type\": \"metric\",\n \"type_id\": 0\n },\n \"errors\": [\n {\n \"error\": \"eu Duis in dolore ut\"\n },\n {\n \"error\": \"do cupidatat\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id/history?from_ts=74288761&to_ts=74288761&target=81.04101124863735&apply_correction=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id",
"history"
],
"query": [
{
"key": "from_ts",
"value": "74288761",
"description": "(Required) The `from` timestamp for the query window in epoch seconds."
},
{
"key": "to_ts",
"value": "74288761",
"description": "(Required) The `to` timestamp for the query window in epoch seconds."
},
{
"key": "target",
"value": "81.04101124863735",
"description": "The SLO target. If `target` is passed in, the response will include the remaining error budget and a timeframe value of `custom`."
},
{
"key": "apply_correction",
"value": "true",
"description": "Defaults to `true`. If any SLO corrections are applied and this parameter is set to `false`,\nthen the corrections will not be applied and the SLI values will not be affected."
}
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id/history?from_ts=74288761&to_ts=74288761&target=81.04101124863735&apply_correction=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id",
"history"
],
"query": [
{
"key": "from_ts",
"value": "74288761",
"description": "(Required) The `from` timestamp for the query window in epoch seconds."
},
{
"key": "to_ts",
"value": "74288761",
"description": "(Required) The `to` timestamp for the query window in epoch seconds."
},
{
"key": "target",
"value": "81.04101124863735",
"description": "The SLO target. If `target` is passed in, the response will include the remaining error budget and a timeframe value of `custom`."
},
{
"key": "apply_correction",
"value": "true",
"description": "Defaults to `true`. If any SLO corrections are applied and this parameter is set to `false`,\nthen the corrections will not be applied and the SLI values will not be affected."
}
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id/history?from_ts=74288761&to_ts=74288761&target=81.04101124863735&apply_correction=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id",
"history"
],
"query": [
{
"key": "from_ts",
"value": "74288761",
"description": "(Required) The `from` timestamp for the query window in epoch seconds."
},
{
"key": "to_ts",
"value": "74288761",
"description": "(Required) The `to` timestamp for the query window in epoch seconds."
},
{
"key": "target",
"value": "81.04101124863735",
"description": "The SLO target. If `target` is passed in, the response will include the remaining error budget and a timeframe value of `custom`."
},
{
"key": "apply_correction",
"value": "true",
"description": "Defaults to `true`. If any SLO corrections are applied and this parameter is set to `false`,\nthen the corrections will not be applied and the SLI values will not be affected."
}
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id/history?from_ts=74288761&to_ts=74288761&target=81.04101124863735&apply_correction=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id",
"history"
],
"query": [
{
"key": "from_ts",
"value": "74288761",
"description": "(Required) The `from` timestamp for the query window in epoch seconds."
},
{
"key": "to_ts",
"value": "74288761",
"description": "(Required) The `to` timestamp for the query window in epoch seconds."
},
{
"key": "target",
"value": "81.04101124863735",
"description": "The SLO target. If `target` is passed in, the response will include the remaining error budget and a timeframe value of `custom`."
},
{
"key": "apply_correction",
"value": "true",
"description": "Defaults to `true`. If any SLO corrections are applied and this parameter is set to `false`,\nthen the corrections will not be applied and the SLI values will not be affected."
}
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get Corrections For an SLO",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id/corrections",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id",
"corrections"
],
"variable": [
{
"key": "slo_id",
"value": "exercitation consequat"
}
]
},
"description": "Get corrections applied to an SLO"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id/corrections",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id",
"corrections"
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"category\": \"Scheduled Maintenance\",\n \"created_at\": 37057815,\n \"creator\": {\n \"email\": \"sit tempor dolor non deserunt\",\n \"handle\": \"laboris dolor cupidatat sit amet\",\n \"name\": \"dolor adipisicing\"\n },\n \"description\": \"veniam U\",\n \"duration\": 3600,\n \"end\": 95250660,\n \"modified_at\": -94550879,\n \"modifier\": {\n \"email\": \"exercitation\",\n \"handle\": \"voluptate in sit\",\n \"name\": \"Ut ex quis ut\"\n },\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"slo_id\": \"consequat dolor ci\",\n \"start\": -17529711,\n \"timezone\": \"proident magna\"\n },\n \"id\": \"nisi adipisicing ut reprehenderit dolor\",\n \"type\": \"correction\"\n },\n {\n \"attributes\": {\n \"category\": \"Scheduled Maintenance\",\n \"created_at\": 82825400,\n \"creator\": {\n \"email\": \"quis nulla\",\n \"handle\": \"commodo sed sit dolor minim\",\n \"name\": \"id in irure\"\n },\n \"description\": \"officia Lorem fugiat ut\",\n \"duration\": 3600,\n \"end\": 82128074,\n \"modified_at\": 75197463,\n \"modifier\": {\n \"email\": \"ut incididu\",\n \"handle\": \"labore commodo \",\n \"name\": \"sint dolore\"\n },\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"slo_id\": \"exercitation sunt mollit\",\n \"start\": 17831451,\n \"timezone\": \"eiusmod in\"\n },\n \"id\": \"sit commodo ullamco\",\n \"type\": \"correction\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": -96751503,\n \"total_filtered_count\": 69414274\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id/corrections",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id",
"corrections"
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id/corrections",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id",
"corrections"
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id/corrections",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id",
"corrections"
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/:slo_id/corrections",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
":slo_id",
"corrections"
],
"variable": [
{
"key": "slo_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Check if SLOs can be safely deleted",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/can_delete?ids=id1, id2, id3",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"can_delete"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "(Required) A comma separated list of the IDs of the service level objectives objects."
}
]
},
"description": "Check if an SLO can be safely deleted. For example,\nassure an SLO can be deleted without disrupting a dashboard."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/can_delete?ids=id1, id2, id3",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"can_delete"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "(Required) A comma separated list of the IDs of the service level objectives objects."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"ok\": [\n \"qui nostrud commodo nulla\",\n \"sunt qui tempor id in\"\n ]\n },\n \"errors\": {\n \"sit_db8\": \"consequat velit\",\n \"sunt31_\": \"reprehender\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/can_delete?ids=id1, id2, id3",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"can_delete"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "(Required) A comma separated list of the IDs of the service level objectives objects."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/can_delete?ids=id1, id2, id3",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"can_delete"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "(Required) A comma separated list of the IDs of the service level objectives objects."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/can_delete?ids=id1, id2, id3",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"can_delete"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "(Required) A comma separated list of the IDs of the service level objectives objects."
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"ok\": [\n \"qui nostrud commodo nulla\",\n \"sunt qui tempor id in\"\n ]\n },\n \"errors\": {\n \"sit_db8\": \"consequat velit\",\n \"sunt31_\": \"reprehender\"\n }\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo/can_delete?ids=id1, id2, id3",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"can_delete"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "(Required) A comma separated list of the IDs of the service level objectives objects."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Bulk Delete SLO Timeframes",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id1\": [\n \"7d\",\n \"30d\"\n ],\n \"id2\": [\n \"7d\",\n \"30d\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/bulk_delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"bulk_delete"
]
},
"description": "Delete (or partially delete) multiple service level objective objects.\n\nThis endpoint facilitates deletion of one or more thresholds for one or more\nservice level objective objects. If all thresholds are deleted, the service level\nobjective object is deleted as well."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id1\": [\n \"7d\",\n \"30d\"\n ],\n \"id2\": [\n \"7d\",\n \"30d\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/bulk_delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"bulk_delete"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"deleted\": [\n \"enim do ut\",\n \"enim non cillum\"\n ],\n \"updated\": [\n \"dolor non ea nisi\",\n \"dolore deserunt in\"\n ]\n },\n \"errors\": [\n {\n \"id\": \"\",\n \"timeframe\": \"30d\",\n \"message\": \"\"\n },\n {\n \"id\": \"\",\n \"timeframe\": \"30d\",\n \"message\": \"\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id1\": [\n \"7d\",\n \"30d\"\n ],\n \"id2\": [\n \"7d\",\n \"30d\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/bulk_delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"bulk_delete"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id1\": [\n \"7d\",\n \"30d\"\n ],\n \"id2\": [\n \"7d\",\n \"30d\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/bulk_delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"bulk_delete"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id1\": [\n \"7d\",\n \"30d\"\n ],\n \"id2\": [\n \"7d\",\n \"30d\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/bulk_delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"bulk_delete"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "[Service Level Objectives](https://docs.datadoghq.com/monitors/service_level_objectives/#configuration)\n(or SLOs) are a key part of the site reliability engineering toolkit.\nSLOs provide a framework for defining clear targets around application performance,\nwhich ultimately help teams provide a consistent customer experience,\nbalance feature development with platform stability,\nand improve communication with internal and external users.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Slack Integration",
"item": [
{
"name": "Get all channels in a Slack integration",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels"
],
"variable": [
{
"key": "account_name",
"value": "pariatur"
}
]
},
"description": "Get a list of all channels configured for your Datadog-Slack integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels"
],
"variable": [
{
"key": "account_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "[\n {\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#channel_name_main_account\"\n },\n {\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": false,\n \"tags\": true\n },\n \"name\": \"#channel_name_doghouse\"\n }\n]"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels"
],
"variable": [
{
"key": "account_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels"
],
"variable": [
{
"key": "account_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels"
],
"variable": [
{
"key": "account_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels"
],
"variable": [
{
"key": "account_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a Slack integration channel",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#general\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels"
],
"variable": [
{
"key": "account_name",
"value": "pariatur"
}
]
},
"description": "Add a channel to your Datadog-Slack integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#general\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels"
],
"variable": [
{
"key": "account_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#general\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#general\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels"
],
"variable": [
{
"key": "account_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#general\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels"
],
"variable": [
{
"key": "account_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#general\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels"
],
"variable": [
{
"key": "account_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#general\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels"
],
"variable": [
{
"key": "account_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a Slack integration channel",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name",
"value": "pariatur"
},
{
"key": "channel_name",
"value": "pariatur"
}
]
},
"description": "Get a channel configured for your Datadog-Slack integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#general\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a Slack integration channel",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#general\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name",
"value": "pariatur"
},
{
"key": "channel_name",
"value": "pariatur"
}
]
},
"description": "Update a channel used in your Datadog-Slack integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#general\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#general\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#general\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#general\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#general\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"display\": {\n \"message\": true,\n \"notified\": true,\n \"snapshot\": true,\n \"tags\": true\n },\n \"name\": \"#general\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Remove a Slack integration channel",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name",
"value": "pariatur"
},
{
"key": "channel_name",
"value": "pariatur"
}
]
},
"description": "Remove a channel from your Datadog-Slack integration."
},
"response": [
{
"name": "The channel was removed successfully.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"slack",
"configuration",
"accounts",
":account_name",
"channels",
":channel_name"
],
"variable": [
{
"key": "account_name"
},
{
"key": "channel_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Configure your [Datadog-Slack integration](https://docs.datadoghq.com/integrations/slack)\ndirectly through the Datadog API.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Snapshots",
"item": [
{
"name": "Take graph snapshots",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/snapshot?start=-32260706&end=-32260706",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"snapshot"
],
"query": [
{
"key": "metric_query",
"value": "pariatur",
"description": "The metric query.",
"disabled": true
},
{
"key": "start",
"value": "-32260706",
"description": "(Required) The POSIX timestamp of the start of the query in seconds."
},
{
"key": "end",
"value": "-32260706",
"description": "(Required) The POSIX timestamp of the end of the query in seconds."
},
{
"key": "event_query",
"value": "pariatur",
"description": "A query that adds event bands to the graph.",
"disabled": true
},
{
"key": "graph_def",
"value": "pariatur",
"description": "A JSON document defining the graph. `graph_def` can be used instead of `metric_query`.\nThe JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar)\nand should be formatted to a single line then URL encoded.",
"disabled": true
},
{
"key": "title",
"value": "pariatur",
"description": "A title for the graph. If no title is specified, the graph does not have a title.",
"disabled": true
},
{
"key": "height",
"value": "-32260706",
"description": "The height of the graph. If no height is specified, the graph's original height is used.",
"disabled": true
},
{
"key": "width",
"value": "-32260706",
"description": "The width of the graph. If no width is specified, the graph's original width is used.",
"disabled": true
}
]
},
"description": "Take graph snapshots.\n**Note**: When a snapshot is created, there is some delay before it is available."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/snapshot?start=-32260706&end=-32260706",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"snapshot"
],
"query": [
{
"key": "metric_query",
"value": "pariatur",
"description": "The metric query.",
"disabled": true
},
{
"key": "start",
"value": "-32260706",
"description": "(Required) The POSIX timestamp of the start of the query in seconds."
},
{
"key": "end",
"value": "-32260706",
"description": "(Required) The POSIX timestamp of the end of the query in seconds."
},
{
"key": "event_query",
"value": "pariatur",
"description": "A query that adds event bands to the graph.",
"disabled": true
},
{
"key": "graph_def",
"value": "pariatur",
"description": "A JSON document defining the graph. `graph_def` can be used instead of `metric_query`.\nThe JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar)\nand should be formatted to a single line then URL encoded.",
"disabled": true
},
{
"key": "title",
"value": "pariatur",
"description": "A title for the graph. If no title is specified, the graph does not have a title.",
"disabled": true
},
{
"key": "height",
"value": "-32260706",
"description": "The height of the graph. If no height is specified, the graph's original height is used.",
"disabled": true
},
{
"key": "width",
"value": "-32260706",
"description": "The width of the graph. If no width is specified, the graph's original width is used.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"graph_def\": \"exercitation sit nulla ad\",\n \"metric_query\": \"nulla deserunt dolore nisi\",\n \"snapshot_url\": \"https://app.datadoghq.com/s/f12345678/aaa-bbb-ccc\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/snapshot?start=-32260706&end=-32260706",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"snapshot"
],
"query": [
{
"key": "metric_query",
"value": "pariatur",
"description": "The metric query.",
"disabled": true
},
{
"key": "start",
"value": "-32260706",
"description": "(Required) The POSIX timestamp of the start of the query in seconds."
},
{
"key": "end",
"value": "-32260706",
"description": "(Required) The POSIX timestamp of the end of the query in seconds."
},
{
"key": "event_query",
"value": "pariatur",
"description": "A query that adds event bands to the graph.",
"disabled": true
},
{
"key": "graph_def",
"value": "pariatur",
"description": "A JSON document defining the graph. `graph_def` can be used instead of `metric_query`.\nThe JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar)\nand should be formatted to a single line then URL encoded.",
"disabled": true
},
{
"key": "title",
"value": "pariatur",
"description": "A title for the graph. If no title is specified, the graph does not have a title.",
"disabled": true
},
{
"key": "height",
"value": "-32260706",
"description": "The height of the graph. If no height is specified, the graph's original height is used.",
"disabled": true
},
{
"key": "width",
"value": "-32260706",
"description": "The width of the graph. If no width is specified, the graph's original width is used.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/snapshot?start=-32260706&end=-32260706",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"snapshot"
],
"query": [
{
"key": "metric_query",
"value": "pariatur",
"description": "The metric query.",
"disabled": true
},
{
"key": "start",
"value": "-32260706",
"description": "(Required) The POSIX timestamp of the start of the query in seconds."
},
{
"key": "end",
"value": "-32260706",
"description": "(Required) The POSIX timestamp of the end of the query in seconds."
},
{
"key": "event_query",
"value": "pariatur",
"description": "A query that adds event bands to the graph.",
"disabled": true
},
{
"key": "graph_def",
"value": "pariatur",
"description": "A JSON document defining the graph. `graph_def` can be used instead of `metric_query`.\nThe JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar)\nand should be formatted to a single line then URL encoded.",
"disabled": true
},
{
"key": "title",
"value": "pariatur",
"description": "A title for the graph. If no title is specified, the graph does not have a title.",
"disabled": true
},
{
"key": "height",
"value": "-32260706",
"description": "The height of the graph. If no height is specified, the graph's original height is used.",
"disabled": true
},
{
"key": "width",
"value": "-32260706",
"description": "The width of the graph. If no width is specified, the graph's original width is used.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/snapshot?start=-32260706&end=-32260706",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"snapshot"
],
"query": [
{
"key": "metric_query",
"value": "pariatur",
"description": "The metric query.",
"disabled": true
},
{
"key": "start",
"value": "-32260706",
"description": "(Required) The POSIX timestamp of the start of the query in seconds."
},
{
"key": "end",
"value": "-32260706",
"description": "(Required) The POSIX timestamp of the end of the query in seconds."
},
{
"key": "event_query",
"value": "pariatur",
"description": "A query that adds event bands to the graph.",
"disabled": true
},
{
"key": "graph_def",
"value": "pariatur",
"description": "A JSON document defining the graph. `graph_def` can be used instead of `metric_query`.\nThe JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar)\nand should be formatted to a single line then URL encoded.",
"disabled": true
},
{
"key": "title",
"value": "pariatur",
"description": "A title for the graph. If no title is specified, the graph does not have a title.",
"disabled": true
},
{
"key": "height",
"value": "-32260706",
"description": "The height of the graph. If no height is specified, the graph's original height is used.",
"disabled": true
},
{
"key": "width",
"value": "-32260706",
"description": "The width of the graph. If no width is specified, the graph's original width is used.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Take graph snapshots using the API.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Software Catalog",
"item": [
{
"name": "Get a list of entities",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/entity?page[offset]=0&page[limit]=100&filter[id]=esse commodo&filter[ref]=service:shopping-cart&filter[name]=esse commodo&filter[kind]=esse commodo&filter[owner]=esse commodo&filter[relation][type]=RelationTypeDependencyOf&filter[exclude_snapshot]=esse commodo&include=incident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"entity"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of entities in the response."
},
{
"key": "filter[id]",
"value": "esse commodo",
"description": "Filter entities by UUID."
},
{
"key": "filter[ref]",
"value": "service:shopping-cart",
"description": "Filter entities by reference"
},
{
"key": "filter[name]",
"value": "esse commodo",
"description": "Filter entities by name."
},
{
"key": "filter[kind]",
"value": "esse commodo",
"description": "Filter entities by kind."
},
{
"key": "filter[owner]",
"value": "esse commodo",
"description": "Filter entities by owner."
},
{
"key": "filter[relation][type]",
"value": "RelationTypeDependencyOf",
"description": "Filter entities by relation type."
},
{
"key": "filter[exclude_snapshot]",
"value": "esse commodo",
"description": "Filter entities by excluding snapshotted entities."
},
{
"key": "include",
"value": "incident",
"description": "Include relationship data."
}
]
},
"description": "Get a list of entities from Software Catalog."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/entity?page[offset]=0&page[limit]=100&filter[id]=esse commodo&filter[ref]=service:shopping-cart&filter[name]=esse commodo&filter[kind]=esse commodo&filter[owner]=esse commodo&filter[relation][type]=RelationTypeDependencyOf&filter[exclude_snapshot]=esse commodo&include=incident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"entity"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of entities in the response."
},
{
"key": "filter[id]",
"value": "esse commodo",
"description": "Filter entities by UUID."
},
{
"key": "filter[ref]",
"value": "service:shopping-cart",
"description": "Filter entities by reference"
},
{
"key": "filter[name]",
"value": "esse commodo",
"description": "Filter entities by name."
},
{
"key": "filter[kind]",
"value": "esse commodo",
"description": "Filter entities by kind."
},
{
"key": "filter[owner]",
"value": "esse commodo",
"description": "Filter entities by owner."
},
{
"key": "filter[relation][type]",
"value": "RelationTypeDependencyOf",
"description": "Filter entities by relation type."
},
{
"key": "filter[exclude_snapshot]",
"value": "esse commodo",
"description": "Filter entities by excluding snapshotted entities."
},
{
"key": "include",
"value": "incident",
"description": "Include relationship data."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"apiVersion\": \"proident anim dolor ullamco\",\n \"description\": \"Ut ut\",\n \"displayName\": \"tempor\",\n \"kind\": \"non qui exercitation consectetur\",\n \"name\": \"laborum dolor fugiat incididunt\",\n \"namespace\": \"in aute id exercitation\",\n \"owner\": \"aute do\",\n \"tags\": [\n \"magna\",\n \"eiusmod laborum\"\n ]\n },\n \"id\": \"Duis velit aliqua occaecat cupidatat\",\n \"meta\": {\n \"createdAt\": \"commodo dolor\",\n \"ingestionSource\": \"laborum consequat eu adipisicing\",\n \"modifiedAt\": \"dolor exercitation\",\n \"origin\": \"Excepteur et amet\"\n },\n \"relationships\": {\n \"incidents\": {\n \"data\": [\n {\n \"id\": \"sed ullamco\",\n \"type\": \"c\"\n },\n {\n \"id\": \"ea sunt in anim\",\n \"type\": \"laborum\"\n }\n ]\n },\n \"oncall\": {\n \"data\": [\n {\n \"id\": \"adipisicing consequat aliquip\",\n \"type\": \"magna proident minim Ut\"\n },\n {\n \"id\": \"adipisicing fugiat commodo ea\",\n \"type\": \"in et deserunt\"\n }\n ]\n },\n \"rawSchema\": {\n \"data\": {\n \"id\": \"magna in\",\n \"type\": \"culpa laborum nostrud mollit\"\n }\n },\n \"relatedEntities\": {\n \"data\": [\n {\n \"id\": \"labore est non tempor do\",\n \"type\": \"al\"\n },\n {\n \"id\": \"dolore occaecat\",\n \"type\": \"anim et nostrud\"\n }\n ]\n },\n \"schema\": {\n \"data\": {\n \"id\": \"nisi nostrud\",\n \"type\": \"in dolore cupidatat\"\n }\n }\n },\n \"type\": \"ea aliqua id in\"\n },\n {\n \"attributes\": {\n \"apiVersion\": \"qui\",\n \"description\": \"eu Duis\",\n \"displayName\": \"ut aliqua Excepteur occaecat pariatur\",\n \"kind\": \"esse quis veniam\",\n \"name\": \"nisi magna exercitation ut\",\n \"namespace\": \"in non\",\n \"owner\": \"consequat in occaecat\",\n \"tags\": [\n \"dolore tempor\",\n \"labore\"\n ]\n },\n \"id\": \"fugiat ex\",\n \"meta\": {\n \"createdAt\": \"velit sit eiusmod cupidatat\",\n \"ingestionSource\": \"ullamco ut\",\n \"modifiedAt\": \"deserunt\",\n \"origin\": \"Duis consectetur exercitation\"\n },\n \"relationships\": {\n \"incidents\": {\n \"data\": [\n {\n \"id\": \"Ut ullamco consectetur\",\n \"type\": \"molli\"\n },\n {\n \"id\": \"do amet\",\n \"type\": \"id nostrud\"\n }\n ]\n },\n \"oncall\": {\n \"data\": [\n {\n \"id\": \"deserunt mollit\",\n \"type\": \"laboris exercitation incididunt\"\n },\n {\n \"id\": \"ut amet non\",\n \"type\": \"sit Ut est anim\"\n }\n ]\n },\n \"rawSchema\": {\n \"data\": {\n \"id\": \"ea laboris et ut\",\n \"type\": \"reprehenderit ad magna\"\n }\n },\n \"relatedEntities\": {\n \"data\": [\n {\n \"id\": \"labore exercitation tempor\",\n \"type\": \"velit officia cillum ea\"\n },\n {\n \"id\": \"dolore\",\n \"type\": \"fugiat reprehenderit\"\n }\n ]\n },\n \"schema\": {\n \"data\": {\n \"id\": \"qui commodo aliquip in\",\n \"type\": \"aliqua in\"\n }\n }\n },\n \"type\": \"eiusmod es\"\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"schema\": {\n \"apiVersion\": \"v3\",\n \"kind\": \"service\",\n \"metadata\": {\n \"name\": \"myService\",\n \"additionalOwners\": [\n {\n \"name\": \"\",\n \"type\": \"dolore in\"\n },\n {\n \"name\": \"\",\n \"type\": \"cupidatat Duis culpa qui\"\n }\n ],\n \"contacts\": [\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"labore sunt laborum adipisicing\"\n },\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"consequat minim\"\n }\n ],\n \"description\": \"reprehenderit commodo cupidatat eiusmod\",\n \"displayName\": \"non eiusmod quis ut\",\n \"id\": \"4b163705-23c0-4573-b2fb-f6cea2163fcb\",\n \"inheritFrom\": \"application:default/myapp\",\n \"links\": [\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"Duis commodo do\"\n },\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"amet sed\"\n }\n ],\n \"managed\": {\n \"reprehenderit_\": {},\n \"nulla_95\": {}\n },\n \"namespace\": \"default\",\n \"owner\": \"mollit Ut id\",\n \"tags\": [\n \"this:tag\",\n \"that:tag\"\n ]\n },\n \"datadog\": {\n \"codeLocations\": [\n {\n \"paths\": [\n \"Duis sint eu est sunt\",\n \"consectetur ad anim\"\n ],\n \"repositoryURL\": \"quis exercitation commodo culpa\"\n },\n {\n \"paths\": [\n \"p\",\n \"fugiat voluptate ad\"\n ],\n \"repositoryURL\": \"ut enim commodo incididunt\"\n }\n ],\n \"events\": [\n {\n \"name\": \"cillum dolore laborum ips\",\n \"query\": \"mollit labore elit\"\n },\n {\n \"name\": \"nisi labore\",\n \"query\": \"non anim\"\n }\n ],\n \"logs\": [\n {\n \"name\": \"nostrud exercitation veniam\",\n \"query\": \"enim do occaecat fugiat non\"\n },\n {\n \"name\": \"consectetur aliqua eu vo\",\n \"query\": \"id aliqua\"\n }\n ],\n \"performanceData\": {\n \"tags\": [\n \"mollit commodo nulla\",\n \"pariatur velit labore irure Excepteur\"\n ]\n },\n \"pipelines\": {\n \"fingerprints\": [\n \"et sunt deserunt minim eiusmod\",\n \"occaecat eiusmod\"\n ]\n }\n },\n \"extensions\": {\n \"ex_d\": {}\n },\n \"integrations\": {\n \"opsgenie\": {\n \"serviceURL\": \"https://www.opsgenie.com/service/shopping-cart\",\n \"region\": \"reprehenderit ut sed\"\n },\n \"pagerduty\": {\n \"serviceURL\": \"https://www.pagerduty.com/service-directory/Pshopping-cart\"\n }\n },\n \"spec\": {\n \"componentOf\": [\n \"dolore ut sunt\",\n \"non reprehenderit deserunt ad ipsum\"\n ],\n \"dependsOn\": [\n \"sint aute nisi in\",\n \"do labore commodo enim nulla\"\n ],\n \"languages\": [\n \"cupidatat do\",\n \"ullamco dolore tempor \"\n ],\n \"lifecycle\": \"cupidatat\",\n \"tier\": \"non\",\n \"type\": \"sit\"\n }\n }\n },\n \"id\": \"sunt eu minim eiusmod\",\n \"type\": \"schema\"\n },\n {\n \"attributes\": {\n \"schema\": {\n \"apiVersion\": \"v3\",\n \"kind\": \"service\",\n \"metadata\": {\n \"name\": \"myService\",\n \"additionalOwners\": [\n {\n \"name\": \"\",\n \"type\": \"a\"\n },\n {\n \"name\": \"\",\n \"type\": \"ipsum occaecat minim deserunt\"\n }\n ],\n \"contacts\": [\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"sit nostrud ma\"\n },\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"velit non\"\n }\n ],\n \"description\": \"exercitation Excepteur dolore irure\",\n \"displayName\": \"exercitation et enim\",\n \"id\": \"4b163705-23c0-4573-b2fb-f6cea2163fcb\",\n \"inheritFrom\": \"application:default/myapp\",\n \"links\": [\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"Excepteur elit amet velit\"\n },\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"quis ut\"\n }\n ],\n \"managed\": {\n \"adipisicing_14\": {}\n },\n \"namespace\": \"default\",\n \"owner\": \"sint sed\",\n \"tags\": [\n \"this:tag\",\n \"that:tag\"\n ]\n },\n \"datadog\": {\n \"codeLocations\": [\n {\n \"paths\": [\n \"aliquip exercitation\",\n \"in voluptate labore eu qui\"\n ],\n \"repositoryURL\": \"Ut fugiat aliquip ullamco\"\n },\n {\n \"paths\": [\n \"enim labore laboris veniam\",\n \"ipsum\"\n ],\n \"repositoryURL\": \"reprehenderit in incididunt adipisicing\"\n }\n ],\n \"events\": [\n {\n \"name\": \"Lorem ex\",\n \"query\": \"qui eu in\"\n },\n {\n \"name\": \"non culpa id in\",\n \"query\": \"ipsum in consectetur id\"\n }\n ],\n \"logs\": [\n {\n \"name\": \"in velit voluptate e\",\n \"query\": \"est\"\n },\n {\n \"name\": \"ip\",\n \"query\": \"anim cillum ullamco elit\"\n }\n ],\n \"performanceData\": {\n \"tags\": [\n \"ut eli\",\n \"et dolor\"\n ]\n },\n \"pipelines\": {\n \"fingerprints\": [\n \"proident mollit\",\n \"sit commodo dolore ea\"\n ]\n }\n },\n \"extensions\": {\n \"culpa_5f\": {},\n \"Ut8d9\": {}\n },\n \"integrations\": {\n \"opsgenie\": {\n \"serviceURL\": \"https://www.opsgenie.com/service/shopping-cart\",\n \"region\": \"veniam cupidatat\"\n },\n \"pagerduty\": {\n \"serviceURL\": \"https://www.pagerduty.com/service-directory/Pshopping-cart\"\n }\n },\n \"spec\": {\n \"componentOf\": [\n \"deserunt pariatur minim es\",\n \"incididunt cupidatat enim\"\n ],\n \"dependsOn\": [\n \"mollit do velit irure\",\n \"sint\"\n ],\n \"languages\": [\n \"cupidatat\",\n \"ea enim\"\n ],\n \"lifecycle\": \"aute ea nulla\",\n \"tier\": \"velit\",\n \"type\": \"cupidatat dolore cillum ad\"\n }\n }\n },\n \"id\": \"ut\",\n \"type\": \"schema\"\n }\n ],\n \"links\": {\n \"next\": \"sed dolo\",\n \"previous\": \"veniam voluptate aliquip\",\n \"self\": \"quis laborum \"\n },\n \"meta\": {\n \"count\": 53109590,\n \"includeCount\": 21926182\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/entity?page[offset]=0&page[limit]=100&filter[id]=esse commodo&filter[ref]=service:shopping-cart&filter[name]=esse commodo&filter[kind]=esse commodo&filter[owner]=esse commodo&filter[relation][type]=RelationTypeDependencyOf&filter[exclude_snapshot]=esse commodo&include=incident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"entity"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of entities in the response."
},
{
"key": "filter[id]",
"value": "esse commodo",
"description": "Filter entities by UUID."
},
{
"key": "filter[ref]",
"value": "service:shopping-cart",
"description": "Filter entities by reference"
},
{
"key": "filter[name]",
"value": "esse commodo",
"description": "Filter entities by name."
},
{
"key": "filter[kind]",
"value": "esse commodo",
"description": "Filter entities by kind."
},
{
"key": "filter[owner]",
"value": "esse commodo",
"description": "Filter entities by owner."
},
{
"key": "filter[relation][type]",
"value": "RelationTypeDependencyOf",
"description": "Filter entities by relation type."
},
{
"key": "filter[exclude_snapshot]",
"value": "esse commodo",
"description": "Filter entities by excluding snapshotted entities."
},
{
"key": "include",
"value": "incident",
"description": "Include relationship data."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/entity?page[offset]=0&page[limit]=100&filter[id]=esse commodo&filter[ref]=service:shopping-cart&filter[name]=esse commodo&filter[kind]=esse commodo&filter[owner]=esse commodo&filter[relation][type]=RelationTypeDependencyOf&filter[exclude_snapshot]=esse commodo&include=incident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"entity"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of entities in the response."
},
{
"key": "filter[id]",
"value": "esse commodo",
"description": "Filter entities by UUID."
},
{
"key": "filter[ref]",
"value": "service:shopping-cart",
"description": "Filter entities by reference"
},
{
"key": "filter[name]",
"value": "esse commodo",
"description": "Filter entities by name."
},
{
"key": "filter[kind]",
"value": "esse commodo",
"description": "Filter entities by kind."
},
{
"key": "filter[owner]",
"value": "esse commodo",
"description": "Filter entities by owner."
},
{
"key": "filter[relation][type]",
"value": "RelationTypeDependencyOf",
"description": "Filter entities by relation type."
},
{
"key": "filter[exclude_snapshot]",
"value": "esse commodo",
"description": "Filter entities by excluding snapshotted entities."
},
{
"key": "include",
"value": "incident",
"description": "Include relationship data."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create or update entities",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apiVersion\": \"v3\",\n \"kind\": \"service\",\n \"metadata\": {\n \"name\": \"myService\",\n \"additionalOwners\": [\n {\n \"name\": \"\",\n \"type\": \"ea in ut est\"\n },\n {\n \"name\": \"\",\n \"type\": \"dolor veniam minim\"\n }\n ],\n \"contacts\": [\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"sint irure in\"\n },\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"amet consectetur\"\n }\n ],\n \"description\": \"in dolore aliquip proident\",\n \"displayName\": \"dolor amet exercitation\",\n \"id\": \"4b163705-23c0-4573-b2fb-f6cea2163fcb\",\n \"inheritFrom\": \"application:default/myapp\",\n \"links\": [\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"aliqua dolor quis et\"\n },\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"amet dolor culpa magna Lorem\"\n }\n ],\n \"managed\": {\n \"dolor_e\": {},\n \"nostrud_b\": {},\n \"mollit__c\": {}\n },\n \"namespace\": \"default\",\n \"owner\": \"proident dolore consectetur sit ad\",\n \"tags\": [\n \"this:tag\",\n \"that:tag\"\n ]\n },\n \"datadog\": {\n \"codeLocations\": [\n {\n \"paths\": [\n \"sit Lorem ut\",\n \"non sit \"\n ],\n \"repositoryURL\": \"minim aute dolor\"\n },\n {\n \"paths\": [\n \"qui labore in occaecat\",\n \"ut\"\n ],\n \"repositoryURL\": \"cillum voluptate exercitation culpa est\"\n }\n ],\n \"events\": [\n {\n \"name\": \"Excepteur occaecat ex n\",\n \"query\": \"amet officia Excepteur\"\n },\n {\n \"name\": \"occaecat laborum qui dolor\",\n \"query\": \"cupidatat cillum et\"\n }\n ],\n \"logs\": [\n {\n \"name\": \"do aliqua est\",\n \"query\": \"consequat\"\n },\n {\n \"name\": \"magna do nisi laborum\",\n \"query\": \"sint labore qui\"\n }\n ],\n \"performanceData\": {\n \"tags\": [\n \"eu enim\",\n \"cupidatat\"\n ]\n },\n \"pipelines\": {\n \"fingerprints\": [\n \"incididunt eiusmod cillum\",\n \"magna id incididunt est\"\n ]\n }\n },\n \"extensions\": {\n \"Lorem_fd\": {}\n },\n \"integrations\": {\n \"opsgenie\": {\n \"serviceURL\": \"https://www.opsgenie.com/service/shopping-cart\",\n \"region\": \"amet ipsum fugiat voluptate reprehenderit\"\n },\n \"pagerduty\": {\n \"serviceURL\": \"https://www.pagerduty.com/service-directory/Pshopping-cart\"\n }\n },\n \"spec\": {\n \"componentOf\": [\n \"anim eu ullamco dolore\",\n \"c\"\n ],\n \"dependsOn\": [\n \"in reprehenderit\",\n \"est ad laborum fugiat in\"\n ],\n \"languages\": [\n \"cillum proident nisi exercitation ullamco\",\n \"labore Duis\"\n ],\n \"lifecycle\": \"dolore mollit ipsum eu nostrud\",\n \"tier\": \"dolor l\",\n \"type\": \"est incididunt velit dolo\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/entity",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"entity"
]
},
"description": "Create or update entities in Software Catalog."
},
"response": [
{
"name": "ACCEPTED",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apiVersion\": \"v3\",\n \"kind\": \"service\",\n \"metadata\": {\n \"name\": \"myService\",\n \"additionalOwners\": [\n {\n \"name\": \"\",\n \"type\": \"ea in ut est\"\n },\n {\n \"name\": \"\",\n \"type\": \"dolor veniam minim\"\n }\n ],\n \"contacts\": [\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"sint irure in\"\n },\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"amet consectetur\"\n }\n ],\n \"description\": \"in dolore aliquip proident\",\n \"displayName\": \"dolor amet exercitation\",\n \"id\": \"4b163705-23c0-4573-b2fb-f6cea2163fcb\",\n \"inheritFrom\": \"application:default/myapp\",\n \"links\": [\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"aliqua dolor quis et\"\n },\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"amet dolor culpa magna Lorem\"\n }\n ],\n \"managed\": {\n \"dolor_e\": {},\n \"nostrud_b\": {},\n \"mollit__c\": {}\n },\n \"namespace\": \"default\",\n \"owner\": \"proident dolore consectetur sit ad\",\n \"tags\": [\n \"this:tag\",\n \"that:tag\"\n ]\n },\n \"datadog\": {\n \"codeLocations\": [\n {\n \"paths\": [\n \"sit Lorem ut\",\n \"non sit \"\n ],\n \"repositoryURL\": \"minim aute dolor\"\n },\n {\n \"paths\": [\n \"qui labore in occaecat\",\n \"ut\"\n ],\n \"repositoryURL\": \"cillum voluptate exercitation culpa est\"\n }\n ],\n \"events\": [\n {\n \"name\": \"Excepteur occaecat ex n\",\n \"query\": \"amet officia Excepteur\"\n },\n {\n \"name\": \"occaecat laborum qui dolor\",\n \"query\": \"cupidatat cillum et\"\n }\n ],\n \"logs\": [\n {\n \"name\": \"do aliqua est\",\n \"query\": \"consequat\"\n },\n {\n \"name\": \"magna do nisi laborum\",\n \"query\": \"sint labore qui\"\n }\n ],\n \"performanceData\": {\n \"tags\": [\n \"eu enim\",\n \"cupidatat\"\n ]\n },\n \"pipelines\": {\n \"fingerprints\": [\n \"incididunt eiusmod cillum\",\n \"magna id incididunt est\"\n ]\n }\n },\n \"extensions\": {\n \"Lorem_fd\": {}\n },\n \"integrations\": {\n \"opsgenie\": {\n \"serviceURL\": \"https://www.opsgenie.com/service/shopping-cart\",\n \"region\": \"amet ipsum fugiat voluptate reprehenderit\"\n },\n \"pagerduty\": {\n \"serviceURL\": \"https://www.pagerduty.com/service-directory/Pshopping-cart\"\n }\n },\n \"spec\": {\n \"componentOf\": [\n \"anim eu ullamco dolore\",\n \"c\"\n ],\n \"dependsOn\": [\n \"in reprehenderit\",\n \"est ad laborum fugiat in\"\n ],\n \"languages\": [\n \"cillum proident nisi exercitation ullamco\",\n \"labore Duis\"\n ],\n \"lifecycle\": \"dolore mollit ipsum eu nostrud\",\n \"tier\": \"dolor l\",\n \"type\": \"est incididunt velit dolo\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/entity",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"entity"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"apiVersion\": \"aute id ex\",\n \"description\": \"sunt irure proident ut anim\",\n \"displayName\": \"officia in anim cupidatat eiusmod\",\n \"kind\": \"aute \",\n \"name\": \"quis ut ullamco\",\n \"namespace\": \"amet\",\n \"owner\": \"magna in ullamco non\",\n \"tags\": [\n \"cupidatat anim\",\n \"ex eiusmod incididunt in\"\n ]\n },\n \"id\": \"officia sit in ullamco\",\n \"meta\": {\n \"createdAt\": \"laborum irure commodo\",\n \"ingestionSource\": \"culpa\",\n \"modifiedAt\": \"dolor sit Lorem\",\n \"origin\": \"est aliqua\"\n },\n \"relationships\": {\n \"incidents\": {\n \"data\": [\n {\n \"id\": \"aute\",\n \"type\": \"Duis laborum mollit dolore\"\n },\n {\n \"id\": \"amet aliqua\",\n \"type\": \"occaecat ut aute nulla irure\"\n }\n ]\n },\n \"oncall\": {\n \"data\": [\n {\n \"id\": \"labore nostrud dolore sunt\",\n \"type\": \"nulla reprehenderit\"\n },\n {\n \"id\": \"amet ad consectetur magna velit\",\n \"type\": \"fugiat in Excepteur incidid\"\n }\n ]\n },\n \"rawSchema\": {\n \"data\": {\n \"id\": \"dolor labore magna occaecat\",\n \"type\": \"exercitation\"\n }\n },\n \"relatedEntities\": {\n \"data\": [\n {\n \"id\": \"officia deserunt incididunt cillum\",\n \"type\": \"culpa enim elit qui\"\n },\n {\n \"id\": \"ex Duis\",\n \"type\": \"Duis ut nulla Excepteur\"\n }\n ]\n },\n \"schema\": {\n \"data\": {\n \"id\": \"in mollit laboris\",\n \"type\": \"nostrud ex fugiat Ut\"\n }\n }\n },\n \"type\": \"est cupidatat do consectetur\"\n },\n {\n \"attributes\": {\n \"apiVersion\": \"magna aliqua est\",\n \"description\": \"amet proident\",\n \"displayName\": \"ea ut sed\",\n \"kind\": \"aliquip exercitation deserunt\",\n \"name\": \"exercitation ea dolore esse tempor\",\n \"namespace\": \"cillum\",\n \"owner\": \"commodo non\",\n \"tags\": [\n \"aliquip enim in\",\n \"mollit sunt ut deserunt Duis\"\n ]\n },\n \"id\": \"Lorem eiusmod fugi\",\n \"meta\": {\n \"createdAt\": \"fugiat laboris esse\",\n \"ingestionSource\": \"ex cillum aliqua\",\n \"modifiedAt\": \"mollit in et Excepteur\",\n \"origin\": \"anim eiusmod\"\n },\n \"relationships\": {\n \"incidents\": {\n \"data\": [\n {\n \"id\": \"occaecat nulla dolore non anim\",\n \"type\": \"sunt aliqua\"\n },\n {\n \"id\": \"ipsum Duis tempor\",\n \"type\": \"irure\"\n }\n ]\n },\n \"oncall\": {\n \"data\": [\n {\n \"id\": \"mollit qui\",\n \"type\": \"ipsum irure ad eiusmod\"\n },\n {\n \"id\": \"veniam in\",\n \"type\": \"ipsum labore ut fugiat Excepteur\"\n }\n ]\n },\n \"rawSchema\": {\n \"data\": {\n \"id\": \"laboru\",\n \"type\": \"Lorem cupidatat\"\n }\n },\n \"relatedEntities\": {\n \"data\": [\n {\n \"id\": \"aliqua culpa Ut deserunt dolor\",\n \"type\": \"ut tempor consequat in\"\n },\n {\n \"id\": \"anim ut adipisicing\",\n \"type\": \"cupidatat\"\n }\n ]\n },\n \"schema\": {\n \"data\": {\n \"id\": \"pariatur incididunt\",\n \"type\": \"sed\"\n }\n }\n },\n \"type\": \"veniam ad voluptate et\"\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"schema\": {\n \"apiVersion\": \"v3\",\n \"kind\": \"service\",\n \"metadata\": {\n \"name\": \"myService\",\n \"additionalOwners\": [\n {\n \"name\": \"\",\n \"type\": \"ut am\"\n },\n {\n \"name\": \"\",\n \"type\": \"do Ut\"\n }\n ],\n \"contacts\": [\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"elit dolor deserunt nulla\"\n },\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"quis exercitation\"\n }\n ],\n \"description\": \"enim id\",\n \"displayName\": \"adipisicing voluptate\",\n \"id\": \"4b163705-23c0-4573-b2fb-f6cea2163fcb\",\n \"inheritFrom\": \"application:default/myapp\",\n \"links\": [\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"nostrud irure do\"\n },\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"aliquip nisi consectetur\"\n }\n ],\n \"managed\": {\n \"ex6fc\": {},\n \"exercitation6\": {}\n },\n \"namespace\": \"default\",\n \"owner\": \"consequat eiusmod\",\n \"tags\": [\n \"this:tag\",\n \"that:tag\"\n ]\n },\n \"datadog\": {\n \"codeLocations\": [\n {\n \"paths\": [\n \"Ut incididunt dolore nulla\",\n \"ut\"\n ],\n \"repositoryURL\": \"aliquip eu\"\n },\n {\n \"paths\": [\n \"fugiat consectetur\",\n \"anim incididunt\"\n ],\n \"repositoryURL\": \"Ut voluptate\"\n }\n ],\n \"events\": [\n {\n \"name\": \"nostrud aliquip ipsum Duis\",\n \"query\": \"velit su\"\n },\n {\n \"name\": \"proident occaecat deserunt\",\n \"query\": \"rep\"\n }\n ],\n \"logs\": [\n {\n \"name\": \"dolor et L\",\n \"query\": \"consequat Excepteur in non Duis\"\n },\n {\n \"name\": \"non\",\n \"query\": \"quis laborum\"\n }\n ],\n \"performanceData\": {\n \"tags\": [\n \"id\",\n \"velit commodo dolore deserunt amet\"\n ]\n },\n \"pipelines\": {\n \"fingerprints\": [\n \"est laborum sint exercitation officia\",\n \"ut in cupidatat\"\n ]\n }\n },\n \"extensions\": {\n \"aute_67d\": {}\n },\n \"integrations\": {\n \"opsgenie\": {\n \"serviceURL\": \"https://www.opsgenie.com/service/shopping-cart\",\n \"region\": \"aliqua veniam\"\n },\n \"pagerduty\": {\n \"serviceURL\": \"https://www.pagerduty.com/service-directory/Pshopping-cart\"\n }\n },\n \"spec\": {\n \"componentOf\": [\n \"elit eiusmod\",\n \"nulla commodo consequat esse\"\n ],\n \"dependsOn\": [\n \"Lorem velit\",\n \"sunt culpa\"\n ],\n \"languages\": [\n \"adipisicing\",\n \"anim tempor pariatur\"\n ],\n \"lifecycle\": \"amet dolore\",\n \"tier\": \"nisi pariatur\",\n \"type\": \"laboris nisi con\"\n }\n }\n },\n \"id\": \"deserunt do aute qui\",\n \"type\": \"schema\"\n },\n {\n \"attributes\": {\n \"schema\": {\n \"apiVersion\": \"v3\",\n \"kind\": \"service\",\n \"metadata\": {\n \"name\": \"myService\",\n \"additionalOwners\": [\n {\n \"name\": \"\",\n \"type\": \"voluptate in veniam irure\"\n },\n {\n \"name\": \"\",\n \"type\": \"occaecat fugiat \"\n }\n ],\n \"contacts\": [\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"magna voluptate aliq\"\n },\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"ad sunt in\"\n }\n ],\n \"description\": \"ad amet\",\n \"displayName\": \"sunt magna laboris anim\",\n \"id\": \"4b163705-23c0-4573-b2fb-f6cea2163fcb\",\n \"inheritFrom\": \"application:default/myapp\",\n \"links\": [\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"officia consectetur dolore tempor \"\n },\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"Ut sunt voluptate esse\"\n }\n ],\n \"managed\": {\n \"consectetur93\": {},\n \"Duisfe\": {}\n },\n \"namespace\": \"default\",\n \"owner\": \"conse\",\n \"tags\": [\n \"this:tag\",\n \"that:tag\"\n ]\n },\n \"datadog\": {\n \"codeLocations\": [\n {\n \"paths\": [\n \"cillum nostrud et incididunt\",\n \"laboris proident nostrud commodo\"\n ],\n \"repositoryURL\": \"aliqua\"\n },\n {\n \"paths\": [\n \"Ut dolore quis minim\",\n \"consequat sit reprehenderit\"\n ],\n \"repositoryURL\": \"dolor ut Lorem velit\"\n }\n ],\n \"events\": [\n {\n \"name\": \"anim incididunt dolor\",\n \"query\": \"proident velit\"\n },\n {\n \"name\": \"proident\",\n \"query\": \"Lorem in sunt id\"\n }\n ],\n \"logs\": [\n {\n \"name\": \"non\",\n \"query\": \"do sit incididunt\"\n },\n {\n \"name\": \"tempor nulla\",\n \"query\": \"commodo fugiat\"\n }\n ],\n \"performanceData\": {\n \"tags\": [\n \"laboris ex\",\n \"do\"\n ]\n },\n \"pipelines\": {\n \"fingerprints\": [\n \"mollit dolore voluptate occaecat\",\n \"consequat Excepteur anim veniam cupidatat\"\n ]\n }\n },\n \"extensions\": {\n \"exercitationa2\": {},\n \"reprehenderit_f3d\": {}\n },\n \"integrations\": {\n \"opsgenie\": {\n \"serviceURL\": \"https://www.opsgenie.com/service/shopping-cart\",\n \"region\": \"in Ut aute\"\n },\n \"pagerduty\": {\n \"serviceURL\": \"https://www.pagerduty.com/service-directory/Pshopping-cart\"\n }\n },\n \"spec\": {\n \"componentOf\": [\n \"in proident nostrud fugiat anim\",\n \"incididunt aute sed molli\"\n ],\n \"dependsOn\": [\n \"consequat fugiat velit exercitation\",\n \"deserunt sint in dolor\"\n ],\n \"languages\": [\n \"dolore p\",\n \"minim repre\"\n ],\n \"lifecycle\": \"aliqua eiusmod in\",\n \"tier\": \"U\",\n \"type\": \"labore\"\n }\n }\n },\n \"id\": \"exercitation nulla cupidatat E\",\n \"type\": \"schema\"\n }\n ],\n \"meta\": {\n \"count\": -69039432,\n \"includeCount\": -84260248\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apiVersion\": \"v3\",\n \"kind\": \"service\",\n \"metadata\": {\n \"name\": \"myService\",\n \"additionalOwners\": [\n {\n \"name\": \"\",\n \"type\": \"ea in ut est\"\n },\n {\n \"name\": \"\",\n \"type\": \"dolor veniam minim\"\n }\n ],\n \"contacts\": [\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"sint irure in\"\n },\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"amet consectetur\"\n }\n ],\n \"description\": \"in dolore aliquip proident\",\n \"displayName\": \"dolor amet exercitation\",\n \"id\": \"4b163705-23c0-4573-b2fb-f6cea2163fcb\",\n \"inheritFrom\": \"application:default/myapp\",\n \"links\": [\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"aliqua dolor quis et\"\n },\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"amet dolor culpa magna Lorem\"\n }\n ],\n \"managed\": {\n \"dolor_e\": {},\n \"nostrud_b\": {},\n \"mollit__c\": {}\n },\n \"namespace\": \"default\",\n \"owner\": \"proident dolore consectetur sit ad\",\n \"tags\": [\n \"this:tag\",\n \"that:tag\"\n ]\n },\n \"datadog\": {\n \"codeLocations\": [\n {\n \"paths\": [\n \"sit Lorem ut\",\n \"non sit \"\n ],\n \"repositoryURL\": \"minim aute dolor\"\n },\n {\n \"paths\": [\n \"qui labore in occaecat\",\n \"ut\"\n ],\n \"repositoryURL\": \"cillum voluptate exercitation culpa est\"\n }\n ],\n \"events\": [\n {\n \"name\": \"Excepteur occaecat ex n\",\n \"query\": \"amet officia Excepteur\"\n },\n {\n \"name\": \"occaecat laborum qui dolor\",\n \"query\": \"cupidatat cillum et\"\n }\n ],\n \"logs\": [\n {\n \"name\": \"do aliqua est\",\n \"query\": \"consequat\"\n },\n {\n \"name\": \"magna do nisi laborum\",\n \"query\": \"sint labore qui\"\n }\n ],\n \"performanceData\": {\n \"tags\": [\n \"eu enim\",\n \"cupidatat\"\n ]\n },\n \"pipelines\": {\n \"fingerprints\": [\n \"incididunt eiusmod cillum\",\n \"magna id incididunt est\"\n ]\n }\n },\n \"extensions\": {\n \"Lorem_fd\": {}\n },\n \"integrations\": {\n \"opsgenie\": {\n \"serviceURL\": \"https://www.opsgenie.com/service/shopping-cart\",\n \"region\": \"amet ipsum fugiat voluptate reprehenderit\"\n },\n \"pagerduty\": {\n \"serviceURL\": \"https://www.pagerduty.com/service-directory/Pshopping-cart\"\n }\n },\n \"spec\": {\n \"componentOf\": [\n \"anim eu ullamco dolore\",\n \"c\"\n ],\n \"dependsOn\": [\n \"in reprehenderit\",\n \"est ad laborum fugiat in\"\n ],\n \"languages\": [\n \"cillum proident nisi exercitation ullamco\",\n \"labore Duis\"\n ],\n \"lifecycle\": \"dolore mollit ipsum eu nostrud\",\n \"tier\": \"dolor l\",\n \"type\": \"est incididunt velit dolo\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/entity",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"entity"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apiVersion\": \"v3\",\n \"kind\": \"service\",\n \"metadata\": {\n \"name\": \"myService\",\n \"additionalOwners\": [\n {\n \"name\": \"\",\n \"type\": \"ea in ut est\"\n },\n {\n \"name\": \"\",\n \"type\": \"dolor veniam minim\"\n }\n ],\n \"contacts\": [\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"sint irure in\"\n },\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"amet consectetur\"\n }\n ],\n \"description\": \"in dolore aliquip proident\",\n \"displayName\": \"dolor amet exercitation\",\n \"id\": \"4b163705-23c0-4573-b2fb-f6cea2163fcb\",\n \"inheritFrom\": \"application:default/myapp\",\n \"links\": [\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"aliqua dolor quis et\"\n },\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"amet dolor culpa magna Lorem\"\n }\n ],\n \"managed\": {\n \"dolor_e\": {},\n \"nostrud_b\": {},\n \"mollit__c\": {}\n },\n \"namespace\": \"default\",\n \"owner\": \"proident dolore consectetur sit ad\",\n \"tags\": [\n \"this:tag\",\n \"that:tag\"\n ]\n },\n \"datadog\": {\n \"codeLocations\": [\n {\n \"paths\": [\n \"sit Lorem ut\",\n \"non sit \"\n ],\n \"repositoryURL\": \"minim aute dolor\"\n },\n {\n \"paths\": [\n \"qui labore in occaecat\",\n \"ut\"\n ],\n \"repositoryURL\": \"cillum voluptate exercitation culpa est\"\n }\n ],\n \"events\": [\n {\n \"name\": \"Excepteur occaecat ex n\",\n \"query\": \"amet officia Excepteur\"\n },\n {\n \"name\": \"occaecat laborum qui dolor\",\n \"query\": \"cupidatat cillum et\"\n }\n ],\n \"logs\": [\n {\n \"name\": \"do aliqua est\",\n \"query\": \"consequat\"\n },\n {\n \"name\": \"magna do nisi laborum\",\n \"query\": \"sint labore qui\"\n }\n ],\n \"performanceData\": {\n \"tags\": [\n \"eu enim\",\n \"cupidatat\"\n ]\n },\n \"pipelines\": {\n \"fingerprints\": [\n \"incididunt eiusmod cillum\",\n \"magna id incididunt est\"\n ]\n }\n },\n \"extensions\": {\n \"Lorem_fd\": {}\n },\n \"integrations\": {\n \"opsgenie\": {\n \"serviceURL\": \"https://www.opsgenie.com/service/shopping-cart\",\n \"region\": \"amet ipsum fugiat voluptate reprehenderit\"\n },\n \"pagerduty\": {\n \"serviceURL\": \"https://www.pagerduty.com/service-directory/Pshopping-cart\"\n }\n },\n \"spec\": {\n \"componentOf\": [\n \"anim eu ullamco dolore\",\n \"c\"\n ],\n \"dependsOn\": [\n \"in reprehenderit\",\n \"est ad laborum fugiat in\"\n ],\n \"languages\": [\n \"cillum proident nisi exercitation ullamco\",\n \"labore Duis\"\n ],\n \"lifecycle\": \"dolore mollit ipsum eu nostrud\",\n \"tier\": \"dolor l\",\n \"type\": \"est incididunt velit dolo\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/entity",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"entity"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apiVersion\": \"v3\",\n \"kind\": \"service\",\n \"metadata\": {\n \"name\": \"myService\",\n \"additionalOwners\": [\n {\n \"name\": \"\",\n \"type\": \"ea in ut est\"\n },\n {\n \"name\": \"\",\n \"type\": \"dolor veniam minim\"\n }\n ],\n \"contacts\": [\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"sint irure in\"\n },\n {\n \"type\": \"slack\",\n \"contact\": \"https://slack/\",\n \"name\": \"amet consectetur\"\n }\n ],\n \"description\": \"in dolore aliquip proident\",\n \"displayName\": \"dolor amet exercitation\",\n \"id\": \"4b163705-23c0-4573-b2fb-f6cea2163fcb\",\n \"inheritFrom\": \"application:default/myapp\",\n \"links\": [\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"aliqua dolor quis et\"\n },\n {\n \"name\": \"mylink\",\n \"type\": \"link\",\n \"url\": \"https://mylink\",\n \"provider\": \"amet dolor culpa magna Lorem\"\n }\n ],\n \"managed\": {\n \"dolor_e\": {},\n \"nostrud_b\": {},\n \"mollit__c\": {}\n },\n \"namespace\": \"default\",\n \"owner\": \"proident dolore consectetur sit ad\",\n \"tags\": [\n \"this:tag\",\n \"that:tag\"\n ]\n },\n \"datadog\": {\n \"codeLocations\": [\n {\n \"paths\": [\n \"sit Lorem ut\",\n \"non sit \"\n ],\n \"repositoryURL\": \"minim aute dolor\"\n },\n {\n \"paths\": [\n \"qui labore in occaecat\",\n \"ut\"\n ],\n \"repositoryURL\": \"cillum voluptate exercitation culpa est\"\n }\n ],\n \"events\": [\n {\n \"name\": \"Excepteur occaecat ex n\",\n \"query\": \"amet officia Excepteur\"\n },\n {\n \"name\": \"occaecat laborum qui dolor\",\n \"query\": \"cupidatat cillum et\"\n }\n ],\n \"logs\": [\n {\n \"name\": \"do aliqua est\",\n \"query\": \"consequat\"\n },\n {\n \"name\": \"magna do nisi laborum\",\n \"query\": \"sint labore qui\"\n }\n ],\n \"performanceData\": {\n \"tags\": [\n \"eu enim\",\n \"cupidatat\"\n ]\n },\n \"pipelines\": {\n \"fingerprints\": [\n \"incididunt eiusmod cillum\",\n \"magna id incididunt est\"\n ]\n }\n },\n \"extensions\": {\n \"Lorem_fd\": {}\n },\n \"integrations\": {\n \"opsgenie\": {\n \"serviceURL\": \"https://www.opsgenie.com/service/shopping-cart\",\n \"region\": \"amet ipsum fugiat voluptate reprehenderit\"\n },\n \"pagerduty\": {\n \"serviceURL\": \"https://www.pagerduty.com/service-directory/Pshopping-cart\"\n }\n },\n \"spec\": {\n \"componentOf\": [\n \"anim eu ullamco dolore\",\n \"c\"\n ],\n \"dependsOn\": [\n \"in reprehenderit\",\n \"est ad laborum fugiat in\"\n ],\n \"languages\": [\n \"cillum proident nisi exercitation ullamco\",\n \"labore Duis\"\n ],\n \"lifecycle\": \"dolore mollit ipsum eu nostrud\",\n \"tier\": \"dolor l\",\n \"type\": \"est incididunt velit dolo\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/entity",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"entity"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a single entity",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/entity/:entity_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"entity",
":entity_id"
],
"variable": [
{
"key": "entity_id",
"value": "service:myservice"
}
]
},
"description": "Delete a single entity in Software Catalog."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/entity/:entity_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"entity",
":entity_id"
],
"variable": [
{
"key": "entity_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/entity/:entity_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"entity",
":entity_id"
],
"variable": [
{
"key": "entity_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/entity/:entity_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"entity",
":entity_id"
],
"variable": [
{
"key": "entity_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/entity/:entity_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"entity",
":entity_id"
],
"variable": [
{
"key": "entity_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/entity/:entity_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"entity",
":entity_id"
],
"variable": [
{
"key": "entity_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a list of entity relations",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/relation?page[offset]=0&page[limit]=100&filter[type]=RelationTypeDependencyOf&filter[from_ref]=service:shopping-cart&filter[to_ref]=service:shopping-cart&include=entity",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"relation"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of relations in the response."
},
{
"key": "filter[type]",
"value": "RelationTypeDependencyOf",
"description": "Filter relations by type."
},
{
"key": "filter[from_ref]",
"value": "service:shopping-cart",
"description": "Filter relations by the reference of the first entity in the relation."
},
{
"key": "filter[to_ref]",
"value": "service:shopping-cart",
"description": "Filter relations by the reference of the second entity in the relation."
},
{
"key": "include",
"value": "entity",
"description": "Include relationship data."
}
]
},
"description": "Get a list of entity relations from Software Catalog."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/relation?page[offset]=0&page[limit]=100&filter[type]=RelationTypeDependencyOf&filter[from_ref]=service:shopping-cart&filter[to_ref]=service:shopping-cart&include=entity",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"relation"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of relations in the response."
},
{
"key": "filter[type]",
"value": "RelationTypeDependencyOf",
"description": "Filter relations by type."
},
{
"key": "filter[from_ref]",
"value": "service:shopping-cart",
"description": "Filter relations by the reference of the first entity in the relation."
},
{
"key": "filter[to_ref]",
"value": "service:shopping-cart",
"description": "Filter relations by the reference of the second entity in the relation."
},
{
"key": "include",
"value": "entity",
"description": "Include relationship data."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"from\": {\n \"kind\": \"minim pariatur eiusmod occaecat\",\n \"name\": \"tempor\",\n \"namespace\": \"Ut anim\"\n },\n \"to\": {\n \"kind\": \"dolore mollit irure ea sit\",\n \"name\": \"officia non\",\n \"namespace\": \"dolor laboris\"\n },\n \"type\": \"RelationTypeImplements\"\n },\n \"id\": \"proident cillum minim\",\n \"meta\": {\n \"createdAt\": \"1977-10-24T01:51:00.790Z\",\n \"definedBy\": \"cillum ullamco sed\",\n \"modifiedAt\": \"2006-02-07T10:53:26.002Z\",\n \"source\": \"Ut velit magna\"\n },\n \"relationships\": {\n \"fromEntity\": {\n \"data\": {\n \"id\": \"labore officia\",\n \"type\": \"exercitation irure\"\n },\n \"meta\": {\n \"createdAt\": \"consectetur non\",\n \"ingestionSource\": \"labore deserunt incididunt esse\",\n \"modifiedAt\": \"nostrud\",\n \"origin\": \"velit laborum\"\n }\n },\n \"toEntity\": {\n \"data\": {\n \"id\": \"cillum id et amet eu\",\n \"type\": \"ut cupidatat sunt ipsum\"\n },\n \"meta\": {\n \"createdAt\": \"incididunt\",\n \"ingestionSource\": \"et fugiat in\",\n \"modifiedAt\": \"fugiat aliqua\",\n \"origin\": \"nulla incidid\"\n }\n }\n },\n \"subtype\": \"Excepteur in reprehenderit\",\n \"type\": \"relation\"\n },\n {\n \"attributes\": {\n \"from\": {\n \"kind\": \"irure ipsum velit aliqua dolor\",\n \"name\": \"consectetur nostrud ut\",\n \"namespace\": \"eiusmod\"\n },\n \"to\": {\n \"kind\": \"magna non in\",\n \"name\": \"Lorem pariatur culpa irure\",\n \"namespace\": \"ut fugiat\"\n },\n \"type\": \"RelationTypeOtherOwns\"\n },\n \"id\": \"Duis\",\n \"meta\": {\n \"createdAt\": \"1954-12-17T22:37:16.775Z\",\n \"definedBy\": \"cupidatat fugiat culpa qui\",\n \"modifiedAt\": \"1961-11-09T00:23:59.428Z\",\n \"source\": \"in Duis nostrud\"\n },\n \"relationships\": {\n \"fromEntity\": {\n \"data\": {\n \"id\": \"labore sunt officia ad\",\n \"type\": \"occaecat eu est Duis\"\n },\n \"meta\": {\n \"createdAt\": \"incididunt tempor et laboris\",\n \"ingestionSource\": \"et veniam nulla\",\n \"modifiedAt\": \"es\",\n \"origin\": \"cillum minim aute\"\n }\n },\n \"toEntity\": {\n \"data\": {\n \"id\": \"mollit ipsum qui sunt deserunt\",\n \"type\": \"dolore tempor\"\n },\n \"meta\": {\n \"createdAt\": \"c\",\n \"ingestionSource\": \"sunt ut do\",\n \"modifiedAt\": \"exercitation elit qui\",\n \"origin\": \"commodo minim\"\n }\n }\n },\n \"subtype\": \"aute\",\n \"type\": \"relation\"\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"apiVersion\": \"cupidatat fugiat adipisicing culpa\",\n \"description\": \"in commodo voluptate sunt qui\",\n \"displayName\": \"cillum pariatur\",\n \"kind\": \"aliquip in nulla\",\n \"name\": \"minim dolor commodo\",\n \"namespace\": \"dolore amet\",\n \"owner\": \"volupta\",\n \"tags\": [\n \"aute\",\n \"Lorem consectetur\"\n ]\n },\n \"id\": \"ut ea dolore aute\",\n \"meta\": {\n \"createdAt\": \"Ut sint\",\n \"ingestionSource\": \"ut id cillum culpa exercitation\",\n \"modifiedAt\": \"do culpa\",\n \"origin\": \"consequat culpa dolore\"\n },\n \"relationships\": {\n \"incidents\": {\n \"data\": [\n {\n \"id\": \"aute minim qui id\",\n \"type\": \"ad commodo ea\"\n },\n {\n \"id\": \"sed esse ex\",\n \"type\": \"dolore ut Ut\"\n }\n ]\n },\n \"oncall\": {\n \"data\": [\n {\n \"id\": \"sed veniam\",\n \"type\": \"eu exercitation do\"\n },\n {\n \"id\": \"aliqua ut proident\",\n \"type\": \"Lorem\"\n }\n ]\n },\n \"rawSchema\": {\n \"data\": {\n \"id\": \"dolor laboris dolore\",\n \"type\": \"culpa Ut labore aliqua ut\"\n }\n },\n \"relatedEntities\": {\n \"data\": [\n {\n \"id\": \"eu nostrud ex pariatur sint\",\n \"type\": \"eu\"\n },\n {\n \"id\": \"pariatur\",\n \"type\": \"qui\"\n }\n ]\n },\n \"schema\": {\n \"data\": {\n \"id\": \"irure m\",\n \"type\": \"do nisi et\"\n }\n }\n },\n \"type\": \"minim exercitation elit\"\n },\n {\n \"attributes\": {\n \"apiVersion\": \"enim officia ad id \",\n \"description\": \"et non nostrud\",\n \"displayName\": \"ut amet eiusmod eu\",\n \"kind\": \"reprehenderit\",\n \"name\": \"sit Duis dolore\",\n \"namespace\": \"dolore nulla aliquip\",\n \"owner\": \"ut quis qui\",\n \"tags\": [\n \"dolore ut\",\n \"sint amet aliqua ex\"\n ]\n },\n \"id\": \"amet do\",\n \"meta\": {\n \"createdAt\": \"ea quis\",\n \"ingestionSource\": \"aliquip\",\n \"modifiedAt\": \"mollit nostrud dolore consequat\",\n \"origin\": \"ex Lorem est\"\n },\n \"relationships\": {\n \"incidents\": {\n \"data\": [\n {\n \"id\": \"et dolor sit\",\n \"type\": \"dolore\"\n },\n {\n \"id\": \"incididunt ipsum\",\n \"type\": \"qui fugiat\"\n }\n ]\n },\n \"oncall\": {\n \"data\": [\n {\n \"id\": \"esse cillum culpa\",\n \"type\": \"mollit\"\n },\n {\n \"id\": \"cillum nostrud dolor reprehenderit\",\n \"type\": \"ex reprehenderit dolor\"\n }\n ]\n },\n \"rawSchema\": {\n \"data\": {\n \"id\": \"consectetur aliquip nostrud\",\n \"type\": \"officia incididunt ullamco Duis amet\"\n }\n },\n \"relatedEntities\": {\n \"data\": [\n {\n \"id\": \"minim aute nulla do\",\n \"type\": \"\"\n },\n {\n \"id\": \"ut do\",\n \"type\": \"est eu exercitation tempor\"\n }\n ]\n },\n \"schema\": {\n \"data\": {\n \"id\": \"veniam et Lorem quis Duis\",\n \"type\": \"ea\"\n }\n }\n },\n \"type\": \"Ut proident sed amet\"\n }\n ],\n \"links\": {\n \"next\": \"/api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=2\",\n \"previous\": \"ea ullamco enim dolor\",\n \"self\": \"/api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=0\"\n },\n \"meta\": {\n \"count\": 84381465,\n \"includeCount\": -93137311\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/relation?page[offset]=0&page[limit]=100&filter[type]=RelationTypeDependencyOf&filter[from_ref]=service:shopping-cart&filter[to_ref]=service:shopping-cart&include=entity",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"relation"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of relations in the response."
},
{
"key": "filter[type]",
"value": "RelationTypeDependencyOf",
"description": "Filter relations by type."
},
{
"key": "filter[from_ref]",
"value": "service:shopping-cart",
"description": "Filter relations by the reference of the first entity in the relation."
},
{
"key": "filter[to_ref]",
"value": "service:shopping-cart",
"description": "Filter relations by the reference of the second entity in the relation."
},
{
"key": "include",
"value": "entity",
"description": "Include relationship data."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/relation?page[offset]=0&page[limit]=100&filter[type]=RelationTypeDependencyOf&filter[from_ref]=service:shopping-cart&filter[to_ref]=service:shopping-cart&include=entity",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"relation"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of relations in the response."
},
{
"key": "filter[type]",
"value": "RelationTypeDependencyOf",
"description": "Filter relations by type."
},
{
"key": "filter[from_ref]",
"value": "service:shopping-cart",
"description": "Filter relations by the reference of the first entity in the relation."
},
{
"key": "filter[to_ref]",
"value": "service:shopping-cart",
"description": "Filter relations by the reference of the second entity in the relation."
},
{
"key": "include",
"value": "entity",
"description": "Include relationship data."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a list of entity kinds",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind?page[offset]=0&page[limit]=100&filter[id]=esse commodo&filter[name]=esse commodo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of kinds in the response."
},
{
"key": "filter[id]",
"value": "esse commodo",
"description": "Filter entities by UUID."
},
{
"key": "filter[name]",
"value": "esse commodo",
"description": "Filter entities by name."
}
]
},
"description": "Get a list of entity kinds from Software Catalog."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind?page[offset]=0&page[limit]=100&filter[id]=esse commodo&filter[name]=esse commodo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of kinds in the response."
},
{
"key": "filter[id]",
"value": "esse commodo",
"description": "Filter entities by UUID."
},
{
"key": "filter[name]",
"value": "esse commodo",
"description": "Filter entities by name."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"description\": \"occaecat Ut\",\n \"displayName\": \"incididunt\",\n \"name\": \"my-job\"\n },\n \"id\": \"4b163705-23c0-4573-b2fb-f6cea2163fcb\",\n \"meta\": {\n \"createdAt\": \"quis veniam cupidatat anim\",\n \"modifiedAt\": \"est dolore\"\n },\n \"type\": \"consequat laborum\"\n },\n {\n \"attributes\": {\n \"description\": \"ut Ut laborum commo\",\n \"displayName\": \"ut qui consectetur ex\",\n \"name\": \"my-job\"\n },\n \"id\": \"4b163705-23c0-4573-b2fb-f6cea2163fcb\",\n \"meta\": {\n \"createdAt\": \"ut occaecat culpa\",\n \"modifiedAt\": \"laborum\"\n },\n \"type\": \"cupidatat mollit sit culpa ut\"\n }\n ],\n \"meta\": {\n \"count\": -91359600\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind?page[offset]=0&page[limit]=100&filter[id]=esse commodo&filter[name]=esse commodo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of kinds in the response."
},
{
"key": "filter[id]",
"value": "esse commodo",
"description": "Filter entities by UUID."
},
{
"key": "filter[name]",
"value": "esse commodo",
"description": "Filter entities by name."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind?page[offset]=0&page[limit]=100&filter[id]=esse commodo&filter[name]=esse commodo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of kinds in the response."
},
{
"key": "filter[id]",
"value": "esse commodo",
"description": "Filter entities by UUID."
},
{
"key": "filter[name]",
"value": "esse commodo",
"description": "Filter entities by name."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind?page[offset]=0&page[limit]=100&filter[id]=esse commodo&filter[name]=esse commodo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind"
],
"query": [
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "100",
"description": "Maximum number of kinds in the response."
},
{
"key": "filter[id]",
"value": "esse commodo",
"description": "Filter entities by UUID."
},
{
"key": "filter[name]",
"value": "esse commodo",
"description": "Filter entities by name."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create or update kinds",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"kind\": \"my-job\",\n \"description\": \"consectetur\",\n \"displayName\": \"proident mollit enim\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind"
]
},
"description": "Create or update kinds in Software Catalog."
},
"response": [
{
"name": "ACCEPTED",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"kind\": \"my-job\",\n \"description\": \"consectetur\",\n \"displayName\": \"proident mollit enim\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"description\": \"culpa velit qui\",\n \"displayName\": \"ei\",\n \"name\": \"my-job\"\n },\n \"id\": \"4b163705-23c0-4573-b2fb-f6cea2163fcb\",\n \"meta\": {\n \"createdAt\": \"irure voluptate\",\n \"modifiedAt\": \"eiusmod in culpa veniam\"\n },\n \"type\": \"do aute irure\"\n },\n {\n \"attributes\": {\n \"description\": \"commodo Lorem ea\",\n \"displayName\": \"aliquip dolor\",\n \"name\": \"my-job\"\n },\n \"id\": \"4b163705-23c0-4573-b2fb-f6cea2163fcb\",\n \"meta\": {\n \"createdAt\": \"eiusmod velit Duis reprehenderit\",\n \"modifiedAt\": \"Ut quis Duis nulla\"\n },\n \"type\": \"eu est\"\n }\n ],\n \"meta\": {\n \"count\": 55684410\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"kind\": \"my-job\",\n \"description\": \"consectetur\",\n \"displayName\": \"proident mollit enim\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"kind\": \"my-job\",\n \"description\": \"consectetur\",\n \"displayName\": \"proident mollit enim\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"kind\": \"my-job\",\n \"description\": \"consectetur\",\n \"displayName\": \"proident mollit enim\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a single kind",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind/:kind_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind",
":kind_id"
],
"variable": [
{
"key": "kind_id",
"value": "my-job"
}
]
},
"description": "Delete a single kind in Software Catalog."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind/:kind_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind",
":kind_id"
],
"variable": [
{
"key": "kind_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind/:kind_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind",
":kind_id"
],
"variable": [
{
"key": "kind_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind/:kind_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind",
":kind_id"
],
"variable": [
{
"key": "kind_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind/:kind_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind",
":kind_id"
],
"variable": [
{
"key": "kind_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/catalog/kind/:kind_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"catalog",
"kind",
":kind_id"
],
"variable": [
{
"key": "kind_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "API to create, update, retrieve, and delete Software Catalog entities.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Spans",
"item": [
{
"name": "Get a list of spans",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@datacenter:us @role:db",
"description": "Search query following spans syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2023-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds).",
"disabled": true
},
{
"key": "filter[to]",
"value": "2023-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds).",
"disabled": true
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of spans in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of spans in the response.",
"disabled": true
}
]
},
"description": "List endpoint returns spans that match a span search query.\n[Results are paginated][1].\n\nUse this endpoint to see your latest spans.\nThis endpoint is rate limited to `300` requests per hour.\n\n[1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@datacenter:us @role:db",
"description": "Search query following spans syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2023-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds).",
"disabled": true
},
{
"key": "filter[to]",
"value": "2023-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds).",
"disabled": true
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of spans in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of spans in the response.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"custom\": {\n \"sedcc5\": {}\n },\n \"end_timestamp\": \"2023-01-02T09:42:36.420Z\",\n \"env\": \"prod\",\n \"host\": \"i-0123\",\n \"ingestion_reason\": \"rule\",\n \"parent_id\": \"0\",\n \"resource_hash\": \"a12345678b91c23d\",\n \"resource_name\": \"agent\",\n \"retained_by\": \"retention_filter\",\n \"service\": \"agent\",\n \"single_span\": true,\n \"span_id\": \"1234567890987654321\",\n \"start_timestamp\": \"2023-01-02T09:42:36.320Z\",\n \"tags\": [\n \"team:A\"\n ],\n \"trace_id\": \"1234567890987654321\",\n \"type\": \"web\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"spans\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"custom\": {\n \"irure_dca\": {}\n },\n \"end_timestamp\": \"2023-01-02T09:42:36.420Z\",\n \"env\": \"prod\",\n \"host\": \"i-0123\",\n \"ingestion_reason\": \"rule\",\n \"parent_id\": \"0\",\n \"resource_hash\": \"a12345678b91c23d\",\n \"resource_name\": \"agent\",\n \"retained_by\": \"retention_filter\",\n \"service\": \"agent\",\n \"single_span\": true,\n \"span_id\": \"1234567890987654321\",\n \"start_timestamp\": \"2023-01-02T09:42:36.320Z\",\n \"tags\": [\n \"team:A\"\n ],\n \"trace_id\": \"1234567890987654321\",\n \"type\": \"web\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"spans\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/spans/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@datacenter:us @role:db",
"description": "Search query following spans syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2023-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds).",
"disabled": true
},
{
"key": "filter[to]",
"value": "2023-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds).",
"disabled": true
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of spans in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of spans in the response.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden: Access denied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@datacenter:us @role:db",
"description": "Search query following spans syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2023-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds).",
"disabled": true
},
{
"key": "filter[to]",
"value": "2023-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds).",
"disabled": true
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of spans in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of spans in the response.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Unprocessable Entity.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@datacenter:us @role:db",
"description": "Search query following spans syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2023-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds).",
"disabled": true
},
{
"key": "filter[to]",
"value": "2023-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds).",
"disabled": true
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of spans in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of spans in the response.",
"disabled": true
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests: The rate limit set by the API has been exceeded.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "@datacenter:us @role:db",
"description": "Search query following spans syntax.",
"disabled": true
},
{
"key": "filter[from]",
"value": "2023-01-02T09:42:36.320Z",
"description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds).",
"disabled": true
},
{
"key": "filter[to]",
"value": "2023-01-03T09:42:36.320Z",
"description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds).",
"disabled": true
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of spans in results.",
"disabled": true
},
{
"key": "page[cursor]",
"value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"description": "List following results with a cursor provided in the previous query.",
"disabled": true
},
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of spans in the response.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
},
{
"name": "Search spans",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": -7243542,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n },\n \"type\": \"search_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events",
"search"
]
},
"description": "List endpoint returns spans that match a span search query.\n[Results are paginated][1].\n\nUse this endpoint to build complex spans filtering and search.\nThis endpoint is rate limited to `300` requests per hour.\n\n[1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": -7243542,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n },\n \"type\": \"search_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events",
"search"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"custom\": {\n \"sedcc5\": {}\n },\n \"end_timestamp\": \"2023-01-02T09:42:36.420Z\",\n \"env\": \"prod\",\n \"host\": \"i-0123\",\n \"ingestion_reason\": \"rule\",\n \"parent_id\": \"0\",\n \"resource_hash\": \"a12345678b91c23d\",\n \"resource_name\": \"agent\",\n \"retained_by\": \"retention_filter\",\n \"service\": \"agent\",\n \"single_span\": true,\n \"span_id\": \"1234567890987654321\",\n \"start_timestamp\": \"2023-01-02T09:42:36.320Z\",\n \"tags\": [\n \"team:A\"\n ],\n \"trace_id\": \"1234567890987654321\",\n \"type\": \"web\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"spans\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"customAttribute\": 123,\n \"duration\": 2345\n },\n \"custom\": {\n \"irure_dca\": {}\n },\n \"end_timestamp\": \"2023-01-02T09:42:36.420Z\",\n \"env\": \"prod\",\n \"host\": \"i-0123\",\n \"ingestion_reason\": \"rule\",\n \"parent_id\": \"0\",\n \"resource_hash\": \"a12345678b91c23d\",\n \"resource_name\": \"agent\",\n \"retained_by\": \"retention_filter\",\n \"service\": \"agent\",\n \"single_span\": true,\n \"span_id\": \"1234567890987654321\",\n \"start_timestamp\": \"2023-01-02T09:42:36.320Z\",\n \"tags\": [\n \"team:A\"\n ],\n \"trace_id\": \"1234567890987654321\",\n \"type\": \"web\"\n },\n \"id\": \"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA\",\n \"type\": \"spans\"\n }\n ],\n \"links\": {\n \"next\": \"https://app.datadoghq.com/api/v2/spans/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"meta\": {\n \"elapsed\": 132,\n \"page\": {\n \"after\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\"\n },\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": -7243542,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n },\n \"type\": \"search_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events",
"search"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden: Access denied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": -7243542,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n },\n \"type\": \"search_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events",
"search"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Unprocessable Entity.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": -7243542,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n },\n \"type\": \"search_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events",
"search"
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests: The rate limit set by the API has been exceeded.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": -7243542,\n \"timezone\": \"GMT\"\n },\n \"page\": {\n \"cursor\": \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\",\n \"limit\": 25\n },\n \"sort\": \"timestamp\"\n },\n \"type\": \"search_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events",
"search"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
},
{
"name": "Aggregate spans",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"est eu\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n },\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"Lorem nulla amet\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n }\n ],\n \"options\": {\n \"timeOffset\": -82164158,\n \"timezone\": \"GMT\"\n }\n },\n \"type\": \"aggregate_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"analytics",
"aggregate"
]
},
"description": "The API endpoint to aggregate spans into buckets and compute metrics and timeseries.\nThis endpoint is rate limited to `300` requests per hour."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"est eu\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n },\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"Lorem nulla amet\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n }\n ],\n \"options\": {\n \"timeOffset\": -82164158,\n \"timezone\": \"GMT\"\n }\n },\n \"type\": \"aggregate_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"analytics",
"aggregate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"by\": {\n \"@state\": \"success\",\n \"@version\": \"abc\"\n },\n \"compute\": {},\n \"computes\": {\n \"commodoa_0\": \"magna in amet\",\n \"ea7\": \"qui\",\n \"aliqua3\": \"nostrud commodo ad deserunt\"\n }\n },\n \"id\": \"dolor non deserunt id\",\n \"type\": \"bucket\"\n },\n {\n \"attributes\": {\n \"by\": {\n \"@state\": \"success\",\n \"@version\": \"abc\"\n },\n \"compute\": {},\n \"computes\": {\n \"sunt31\": \"incididunt magna est ex ipsum\",\n \"exercitation24\": \"irure conse\"\n }\n },\n \"id\": \"et\",\n \"type\": \"bucket\"\n }\n ],\n \"meta\": {\n \"elapsed\": 132,\n \"request_id\": \"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n },\n {\n \"code\": \"unknown_index\",\n \"detail\": \"indexes: foo, bar\",\n \"title\": \"One or several indexes are missing or invalid, results hold data from the other indexes\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"est eu\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n },\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"Lorem nulla amet\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n }\n ],\n \"options\": {\n \"timeOffset\": -82164158,\n \"timezone\": \"GMT\"\n }\n },\n \"type\": \"aggregate_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"analytics",
"aggregate"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"est eu\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n },\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"Lorem nulla amet\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n }\n ],\n \"options\": {\n \"timeOffset\": -82164158,\n \"timezone\": \"GMT\"\n }\n },\n \"type\": \"aggregate_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"analytics",
"aggregate"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"compute\": [\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc90\",\n \"interval\": \"5m\",\n \"metric\": \"@duration\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"service:web* AND @http.status_code:[200 TO 299]\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"est eu\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": false\n },\n {\n \"facet\": \"host\",\n \"histogram\": {\n \"interval\": 10,\n \"min\": 50,\n \"max\": 100\n },\n \"limit\": 10,\n \"missing\": \"Lorem nulla amet\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"order\": \"asc\"\n },\n \"total\": true\n }\n ],\n \"options\": {\n \"timeOffset\": -82164158,\n \"timezone\": \"GMT\"\n }\n },\n \"type\": \"aggregate_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"analytics",
"aggregate"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Search and aggregate your spans from your Datadog platform over HTTP.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Spans Metrics",
"item": [
{
"name": "Get all span-based metrics",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
},
"description": "Get the list of configured span-based metrics with their definitions."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": false,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n },\n \"id\": \"my.metric\",\n \"type\": \"spans_metrics\"\n },\n {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": false,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n },\n \"id\": \"my.metric\",\n \"type\": \"spans_metrics\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a span-based metric",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"my.metric\",\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": false,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
},
"description": "Create a metric based on your ingested spans in your organization.\nReturns the span-based metric object from the request body when the request is successful."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"my.metric\",\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": false,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": false,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n },\n \"id\": \"my.metric\",\n \"type\": \"spans_metrics\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"my.metric\",\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": false,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"my.metric\",\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": false,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"my.metric\",\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": false,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"my.metric\",\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": false,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a span-based metric",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id",
"value": "pariatur consequat"
}
]
},
"description": "Get a specific span-based metric from your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": false,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n },\n \"id\": \"my.metric\",\n \"type\": \"spans_metrics\"\n }\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a span-based metric",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": false\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id",
"value": "pariatur consequat"
}
]
},
"description": "Update a specific span-based metric from your organization.\nReturns the span-based metric object from the request body when the request is successful."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": false\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": false,\n \"path\": \"@duration\"\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n },\n \"id\": \"my.metric\",\n \"type\": \"spans_metrics\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": false\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": false\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": false\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": false\n },\n \"filter\": {\n \"query\": \"@http.status_code:200 service:my-service\"\n },\n \"group_by\": [\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n },\n {\n \"path\": \"resource_name\",\n \"tag_name\": \"resource_name\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a span-based metric",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id",
"value": "pariatur consequat"
}
]
},
"description": "Delete a specific span-based metric from your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Manage configuration of [span-based metrics](https://app.datadoghq.com/apm/traces/generate-metrics) for your organization. See [Generate Metrics from Spans](https://docs.datadoghq.com/tracing/trace_pipeline/generate_metrics/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Synthetics",
"item": [
{
"name": "Create an API test",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n },\n {\n \"operator\": \"is\",\n \"target\": 200,\n \"type\": \"statusCode\"\n },\n {\n \"operator\": \"is\",\n \"property\": \"content-type\",\n \"target\": \"text/html; charset=UTF-8\",\n \"type\": \"header\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"azure:eastus\",\n \"aws:eu-west-3\"\n ],\n \"message\": \"MY_NOTIFICATION_MESSAGE\",\n \"name\": \"MY_TEST_NAME\",\n \"options\": {\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"monitor_options\": {\n \"include_tags\": true,\n \"locked\": false,\n \"new_host_delay\": 300,\n \"notify_audit\": false,\n \"notify_no_data\": false,\n \"renotify_interval\": 0\n },\n \"tick_every\": 60\n },\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\n ],\n \"type\": \"api\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api"
]
},
"description": "Create a Synthetic API test."
},
"response": [
{
"name": "OK - Returns the created test details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n },\n {\n \"operator\": \"is\",\n \"target\": 200,\n \"type\": \"statusCode\"\n },\n {\n \"operator\": \"is\",\n \"property\": \"content-type\",\n \"target\": \"text/html; charset=UTF-8\",\n \"type\": \"header\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"azure:eastus\",\n \"aws:eu-west-3\"\n ],\n \"message\": \"MY_NOTIFICATION_MESSAGE\",\n \"name\": \"MY_TEST_NAME\",\n \"options\": {\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"monitor_options\": {\n \"include_tags\": true,\n \"locked\": false,\n \"new_host_delay\": 300,\n \"notify_audit\": false,\n \"notify_no_data\": false,\n \"renotify_interval\": 0\n },\n \"tick_every\": 60\n },\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\n ],\n \"type\": \"api\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"Example test name\",\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"options\": {\n \"accept_self_signed\": false,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": true,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": false,\n \"disableCors\": true,\n \"disableCsp\": false,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -37997999,\n \"min_failure_duration\": 77817896,\n \"min_location_failed\": 38023074,\n \"monitor_name\": \"cupidatat dolore non ut\",\n \"monitor_options\": {\n \"escalation_message\": \"veniam incididunt voluptate\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 33247447,\n \"renotify_occurrences\": -71601604\n },\n \"monitor_priority\": 4,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -63582187,\n \"interval\": 46016019.6128844\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 363049\n },\n \"type\": \"api\",\n \"message\": \"Notification message\",\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\n ]\n}"
},
{
"name": "- JSON format is wrong\n- Creation failed",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n },\n {\n \"operator\": \"is\",\n \"target\": 200,\n \"type\": \"statusCode\"\n },\n {\n \"operator\": \"is\",\n \"property\": \"content-type\",\n \"target\": \"text/html; charset=UTF-8\",\n \"type\": \"header\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"azure:eastus\",\n \"aws:eu-west-3\"\n ],\n \"message\": \"MY_NOTIFICATION_MESSAGE\",\n \"name\": \"MY_TEST_NAME\",\n \"options\": {\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"monitor_options\": {\n \"include_tags\": true,\n \"locked\": false,\n \"new_host_delay\": 300,\n \"notify_audit\": false,\n \"notify_no_data\": false,\n \"renotify_interval\": 0\n },\n \"tick_every\": 60\n },\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\n ],\n \"type\": \"api\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Test quota is reached",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n },\n {\n \"operator\": \"is\",\n \"target\": 200,\n \"type\": \"statusCode\"\n },\n {\n \"operator\": \"is\",\n \"property\": \"content-type\",\n \"target\": \"text/html; charset=UTF-8\",\n \"type\": \"header\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"azure:eastus\",\n \"aws:eu-west-3\"\n ],\n \"message\": \"MY_NOTIFICATION_MESSAGE\",\n \"name\": \"MY_TEST_NAME\",\n \"options\": {\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"monitor_options\": {\n \"include_tags\": true,\n \"locked\": false,\n \"new_host_delay\": 300,\n \"notify_audit\": false,\n \"notify_no_data\": false,\n \"renotify_interval\": 0\n },\n \"tick_every\": 60\n },\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\n ],\n \"type\": \"api\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api"
]
}
},
"status": "Payment Required",
"code": 402,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n },\n {\n \"operator\": \"is\",\n \"target\": 200,\n \"type\": \"statusCode\"\n },\n {\n \"operator\": \"is\",\n \"property\": \"content-type\",\n \"target\": \"text/html; charset=UTF-8\",\n \"type\": \"header\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"azure:eastus\",\n \"aws:eu-west-3\"\n ],\n \"message\": \"MY_NOTIFICATION_MESSAGE\",\n \"name\": \"MY_TEST_NAME\",\n \"options\": {\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"monitor_options\": {\n \"include_tags\": true,\n \"locked\": false,\n \"new_host_delay\": 300,\n \"notify_audit\": false,\n \"notify_no_data\": false,\n \"renotify_interval\": 0\n },\n \"tick_every\": 60\n },\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\n ],\n \"type\": \"api\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n },\n {\n \"operator\": \"is\",\n \"target\": 200,\n \"type\": \"statusCode\"\n },\n {\n \"operator\": \"is\",\n \"property\": \"content-type\",\n \"target\": \"text/html; charset=UTF-8\",\n \"type\": \"header\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"azure:eastus\",\n \"aws:eu-west-3\"\n ],\n \"message\": \"MY_NOTIFICATION_MESSAGE\",\n \"name\": \"MY_TEST_NAME\",\n \"options\": {\n \"min_failure_duration\": 0,\n \"min_location_failed\": 1,\n \"monitor_options\": {\n \"include_tags\": true,\n \"locked\": false,\n \"new_host_delay\": 300,\n \"notify_audit\": false,\n \"notify_no_data\": false,\n \"renotify_interval\": 0\n },\n \"tick_every\": 60\n },\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\n ],\n \"type\": \"api\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a browser test",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"consectetur magna dolor\",\n \"filename\": \"ex\",\n \"updatedAt\": \"Excepteur consequat\"\n },\n \"key\": {\n \"content\": \"voluptate in do ut\",\n \"filename\": \"ut sunt exercitation incididunt aliqua\",\n \"updatedAt\": \"in ex\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"exercitation Ut qui incididunt\",\n \"compressedProtoFile\": \"Excepteur labore quis\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"labore exercitation\",\n \"dnsServerPort\": -69565807,\n \"files\": [\n {\n \"bucketKey\": \"fugiat magna proident\",\n \"content\": \"laborum sit incididunt officia proident\",\n \"name\": \"dolore Duis in esse\",\n \"originalFileName\": \"sint culpa nulla ea\",\n \"size\": 445243,\n \"type\": \"proident eu occaecat laborum ea\"\n },\n {\n \"bucketKey\": \"irure laborum ipsum cupidatat\",\n \"content\": \"esse eu deserunt ut\",\n \"name\": \"consequat et\",\n \"originalFileName\": \"magna eu id consequat\",\n \"size\": 1566384,\n \"type\": \"dolore sint nulla dolor\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"cupidatat4\": \"ullamco esse adipisicing\"\n },\n \"headers\": {\n \"in_c\": \"ut est enim Lorem id\",\n \"labore_b\": \"ipsum dolor dolore\"\n },\n \"host\": \"magna aute\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"consequat veniam\",\n \"metadata\": {\n \"Lorem2\": \"ea ullamco occaecat eiusmod\"\n },\n \"method\": \"cupi\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 9,\n \"persistCookies\": true,\n \"port\": -17384036,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eu_7a3\": \"Ut\",\n \"sintbbf\": \"pariatur non consectetur dolor\",\n \"enim__\": \"offic\"\n }\n },\n \"query\": {},\n \"servername\": \"nostrud consequat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": 89752470.07114398,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"i\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": true,\n \"initialNavigationTimeout\": 11733301,\n \"min_failure_duration\": -87057457,\n \"min_location_failed\": -52413111,\n \"monitor_name\": \"elit do reprehenderit laborum\",\n \"monitor_options\": {\n \"escalation_message\": \"anim commodo minim reprehenderit velit\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60519217,\n \"renotify_occurrences\": 227529\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 24009461,\n \"interval\": 97196217.90698808\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 413863\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -97266407,\n \"public_id\": \"in eu\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"deserunt et proident\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"in nisi fugiat\",\n \"timeout\": 90794253,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"voluptate incididunt aliqua sit\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"eiusmod proident enim Duis fugiat\",\n \"timeout\": -46669948,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser"
]
},
"description": "Create a Synthetic browser test."
},
"response": [
{
"name": "OK - Returns the created test details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"consectetur magna dolor\",\n \"filename\": \"ex\",\n \"updatedAt\": \"Excepteur consequat\"\n },\n \"key\": {\n \"content\": \"voluptate in do ut\",\n \"filename\": \"ut sunt exercitation incididunt aliqua\",\n \"updatedAt\": \"in ex\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"exercitation Ut qui incididunt\",\n \"compressedProtoFile\": \"Excepteur labore quis\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"labore exercitation\",\n \"dnsServerPort\": -69565807,\n \"files\": [\n {\n \"bucketKey\": \"fugiat magna proident\",\n \"content\": \"laborum sit incididunt officia proident\",\n \"name\": \"dolore Duis in esse\",\n \"originalFileName\": \"sint culpa nulla ea\",\n \"size\": 445243,\n \"type\": \"proident eu occaecat laborum ea\"\n },\n {\n \"bucketKey\": \"irure laborum ipsum cupidatat\",\n \"content\": \"esse eu deserunt ut\",\n \"name\": \"consequat et\",\n \"originalFileName\": \"magna eu id consequat\",\n \"size\": 1566384,\n \"type\": \"dolore sint nulla dolor\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"cupidatat4\": \"ullamco esse adipisicing\"\n },\n \"headers\": {\n \"in_c\": \"ut est enim Lorem id\",\n \"labore_b\": \"ipsum dolor dolore\"\n },\n \"host\": \"magna aute\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"consequat veniam\",\n \"metadata\": {\n \"Lorem2\": \"ea ullamco occaecat eiusmod\"\n },\n \"method\": \"cupi\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 9,\n \"persistCookies\": true,\n \"port\": -17384036,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eu_7a3\": \"Ut\",\n \"sintbbf\": \"pariatur non consectetur dolor\",\n \"enim__\": \"offic\"\n }\n },\n \"query\": {},\n \"servername\": \"nostrud consequat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": 89752470.07114398,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"i\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": true,\n \"initialNavigationTimeout\": 11733301,\n \"min_failure_duration\": -87057457,\n \"min_location_failed\": -52413111,\n \"monitor_name\": \"elit do reprehenderit laborum\",\n \"monitor_options\": {\n \"escalation_message\": \"anim commodo minim reprehenderit velit\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60519217,\n \"renotify_occurrences\": 227529\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 24009461,\n \"interval\": 97196217.90698808\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 413863\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -97266407,\n \"public_id\": \"in eu\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"deserunt et proident\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"in nisi fugiat\",\n \"timeout\": 90794253,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"voluptate incididunt aliqua sit\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"eiusmod proident enim Duis fugiat\",\n \"timeout\": -46669948,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"consectetur magna dolor\",\n \"filename\": \"ex\",\n \"updatedAt\": \"Excepteur consequat\"\n },\n \"key\": {\n \"content\": \"voluptate in do ut\",\n \"filename\": \"ut sunt exercitation incididunt aliqua\",\n \"updatedAt\": \"in ex\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"exercitation Ut qui incididunt\",\n \"compressedProtoFile\": \"Excepteur labore quis\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"labore exercitation\",\n \"dnsServerPort\": -69565807,\n \"files\": [\n {\n \"bucketKey\": \"fugiat magna proident\",\n \"content\": \"laborum sit incididunt officia proident\",\n \"name\": \"dolore Duis in esse\",\n \"originalFileName\": \"sint culpa nulla ea\",\n \"size\": 445243,\n \"type\": \"proident eu occaecat laborum ea\"\n },\n {\n \"bucketKey\": \"irure laborum ipsum cupidatat\",\n \"content\": \"esse eu deserunt ut\",\n \"name\": \"consequat et\",\n \"originalFileName\": \"magna eu id consequat\",\n \"size\": 1566384,\n \"type\": \"dolore sint nulla dolor\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"cupidatat4\": \"ullamco esse adipisicing\"\n },\n \"headers\": {\n \"in_c\": \"ut est enim Lorem id\",\n \"labore_b\": \"ipsum dolor dolore\"\n },\n \"host\": \"magna aute\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"consequat veniam\",\n \"metadata\": {\n \"Lorem2\": \"ea ullamco occaecat eiusmod\"\n },\n \"method\": \"cupi\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 9,\n \"persistCookies\": true,\n \"port\": -17384036,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eu_7a3\": \"Ut\",\n \"sintbbf\": \"pariatur non consectetur dolor\",\n \"enim__\": \"offic\"\n }\n },\n \"query\": {},\n \"servername\": \"nostrud consequat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": 89752470.07114398,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"i\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": true,\n \"initialNavigationTimeout\": 11733301,\n \"min_failure_duration\": -87057457,\n \"min_location_failed\": -52413111,\n \"monitor_name\": \"elit do reprehenderit laborum\",\n \"monitor_options\": {\n \"escalation_message\": \"anim commodo minim reprehenderit velit\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60519217,\n \"renotify_occurrences\": 227529\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 24009461,\n \"interval\": 97196217.90698808\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 413863\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -97266407,\n \"public_id\": \"in eu\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"deserunt et proident\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"in nisi fugiat\",\n \"timeout\": 90794253,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"voluptate incididunt aliqua sit\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"eiusmod proident enim Duis fugiat\",\n \"timeout\": -46669948,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}"
},
{
"name": "- JSON format is wrong\n- Creation failed",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"consectetur magna dolor\",\n \"filename\": \"ex\",\n \"updatedAt\": \"Excepteur consequat\"\n },\n \"key\": {\n \"content\": \"voluptate in do ut\",\n \"filename\": \"ut sunt exercitation incididunt aliqua\",\n \"updatedAt\": \"in ex\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"exercitation Ut qui incididunt\",\n \"compressedProtoFile\": \"Excepteur labore quis\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"labore exercitation\",\n \"dnsServerPort\": -69565807,\n \"files\": [\n {\n \"bucketKey\": \"fugiat magna proident\",\n \"content\": \"laborum sit incididunt officia proident\",\n \"name\": \"dolore Duis in esse\",\n \"originalFileName\": \"sint culpa nulla ea\",\n \"size\": 445243,\n \"type\": \"proident eu occaecat laborum ea\"\n },\n {\n \"bucketKey\": \"irure laborum ipsum cupidatat\",\n \"content\": \"esse eu deserunt ut\",\n \"name\": \"consequat et\",\n \"originalFileName\": \"magna eu id consequat\",\n \"size\": 1566384,\n \"type\": \"dolore sint nulla dolor\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"cupidatat4\": \"ullamco esse adipisicing\"\n },\n \"headers\": {\n \"in_c\": \"ut est enim Lorem id\",\n \"labore_b\": \"ipsum dolor dolore\"\n },\n \"host\": \"magna aute\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"consequat veniam\",\n \"metadata\": {\n \"Lorem2\": \"ea ullamco occaecat eiusmod\"\n },\n \"method\": \"cupi\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 9,\n \"persistCookies\": true,\n \"port\": -17384036,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eu_7a3\": \"Ut\",\n \"sintbbf\": \"pariatur non consectetur dolor\",\n \"enim__\": \"offic\"\n }\n },\n \"query\": {},\n \"servername\": \"nostrud consequat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": 89752470.07114398,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"i\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": true,\n \"initialNavigationTimeout\": 11733301,\n \"min_failure_duration\": -87057457,\n \"min_location_failed\": -52413111,\n \"monitor_name\": \"elit do reprehenderit laborum\",\n \"monitor_options\": {\n \"escalation_message\": \"anim commodo minim reprehenderit velit\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60519217,\n \"renotify_occurrences\": 227529\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 24009461,\n \"interval\": 97196217.90698808\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 413863\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -97266407,\n \"public_id\": \"in eu\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"deserunt et proident\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"in nisi fugiat\",\n \"timeout\": 90794253,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"voluptate incididunt aliqua sit\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"eiusmod proident enim Duis fugiat\",\n \"timeout\": -46669948,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Test quota is reached",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"consectetur magna dolor\",\n \"filename\": \"ex\",\n \"updatedAt\": \"Excepteur consequat\"\n },\n \"key\": {\n \"content\": \"voluptate in do ut\",\n \"filename\": \"ut sunt exercitation incididunt aliqua\",\n \"updatedAt\": \"in ex\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"exercitation Ut qui incididunt\",\n \"compressedProtoFile\": \"Excepteur labore quis\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"labore exercitation\",\n \"dnsServerPort\": -69565807,\n \"files\": [\n {\n \"bucketKey\": \"fugiat magna proident\",\n \"content\": \"laborum sit incididunt officia proident\",\n \"name\": \"dolore Duis in esse\",\n \"originalFileName\": \"sint culpa nulla ea\",\n \"size\": 445243,\n \"type\": \"proident eu occaecat laborum ea\"\n },\n {\n \"bucketKey\": \"irure laborum ipsum cupidatat\",\n \"content\": \"esse eu deserunt ut\",\n \"name\": \"consequat et\",\n \"originalFileName\": \"magna eu id consequat\",\n \"size\": 1566384,\n \"type\": \"dolore sint nulla dolor\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"cupidatat4\": \"ullamco esse adipisicing\"\n },\n \"headers\": {\n \"in_c\": \"ut est enim Lorem id\",\n \"labore_b\": \"ipsum dolor dolore\"\n },\n \"host\": \"magna aute\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"consequat veniam\",\n \"metadata\": {\n \"Lorem2\": \"ea ullamco occaecat eiusmod\"\n },\n \"method\": \"cupi\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 9,\n \"persistCookies\": true,\n \"port\": -17384036,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eu_7a3\": \"Ut\",\n \"sintbbf\": \"pariatur non consectetur dolor\",\n \"enim__\": \"offic\"\n }\n },\n \"query\": {},\n \"servername\": \"nostrud consequat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": 89752470.07114398,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"i\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": true,\n \"initialNavigationTimeout\": 11733301,\n \"min_failure_duration\": -87057457,\n \"min_location_failed\": -52413111,\n \"monitor_name\": \"elit do reprehenderit laborum\",\n \"monitor_options\": {\n \"escalation_message\": \"anim commodo minim reprehenderit velit\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60519217,\n \"renotify_occurrences\": 227529\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 24009461,\n \"interval\": 97196217.90698808\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 413863\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -97266407,\n \"public_id\": \"in eu\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"deserunt et proident\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"in nisi fugiat\",\n \"timeout\": 90794253,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"voluptate incididunt aliqua sit\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"eiusmod proident enim Duis fugiat\",\n \"timeout\": -46669948,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser"
]
}
},
"status": "Payment Required",
"code": 402,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"consectetur magna dolor\",\n \"filename\": \"ex\",\n \"updatedAt\": \"Excepteur consequat\"\n },\n \"key\": {\n \"content\": \"voluptate in do ut\",\n \"filename\": \"ut sunt exercitation incididunt aliqua\",\n \"updatedAt\": \"in ex\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"exercitation Ut qui incididunt\",\n \"compressedProtoFile\": \"Excepteur labore quis\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"labore exercitation\",\n \"dnsServerPort\": -69565807,\n \"files\": [\n {\n \"bucketKey\": \"fugiat magna proident\",\n \"content\": \"laborum sit incididunt officia proident\",\n \"name\": \"dolore Duis in esse\",\n \"originalFileName\": \"sint culpa nulla ea\",\n \"size\": 445243,\n \"type\": \"proident eu occaecat laborum ea\"\n },\n {\n \"bucketKey\": \"irure laborum ipsum cupidatat\",\n \"content\": \"esse eu deserunt ut\",\n \"name\": \"consequat et\",\n \"originalFileName\": \"magna eu id consequat\",\n \"size\": 1566384,\n \"type\": \"dolore sint nulla dolor\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"cupidatat4\": \"ullamco esse adipisicing\"\n },\n \"headers\": {\n \"in_c\": \"ut est enim Lorem id\",\n \"labore_b\": \"ipsum dolor dolore\"\n },\n \"host\": \"magna aute\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"consequat veniam\",\n \"metadata\": {\n \"Lorem2\": \"ea ullamco occaecat eiusmod\"\n },\n \"method\": \"cupi\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 9,\n \"persistCookies\": true,\n \"port\": -17384036,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eu_7a3\": \"Ut\",\n \"sintbbf\": \"pariatur non consectetur dolor\",\n \"enim__\": \"offic\"\n }\n },\n \"query\": {},\n \"servername\": \"nostrud consequat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": 89752470.07114398,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"i\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": true,\n \"initialNavigationTimeout\": 11733301,\n \"min_failure_duration\": -87057457,\n \"min_location_failed\": -52413111,\n \"monitor_name\": \"elit do reprehenderit laborum\",\n \"monitor_options\": {\n \"escalation_message\": \"anim commodo minim reprehenderit velit\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60519217,\n \"renotify_occurrences\": 227529\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 24009461,\n \"interval\": 97196217.90698808\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 413863\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -97266407,\n \"public_id\": \"in eu\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"deserunt et proident\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"in nisi fugiat\",\n \"timeout\": 90794253,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"voluptate incididunt aliqua sit\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"eiusmod proident enim Duis fugiat\",\n \"timeout\": -46669948,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"consectetur magna dolor\",\n \"filename\": \"ex\",\n \"updatedAt\": \"Excepteur consequat\"\n },\n \"key\": {\n \"content\": \"voluptate in do ut\",\n \"filename\": \"ut sunt exercitation incididunt aliqua\",\n \"updatedAt\": \"in ex\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"exercitation Ut qui incididunt\",\n \"compressedProtoFile\": \"Excepteur labore quis\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"labore exercitation\",\n \"dnsServerPort\": -69565807,\n \"files\": [\n {\n \"bucketKey\": \"fugiat magna proident\",\n \"content\": \"laborum sit incididunt officia proident\",\n \"name\": \"dolore Duis in esse\",\n \"originalFileName\": \"sint culpa nulla ea\",\n \"size\": 445243,\n \"type\": \"proident eu occaecat laborum ea\"\n },\n {\n \"bucketKey\": \"irure laborum ipsum cupidatat\",\n \"content\": \"esse eu deserunt ut\",\n \"name\": \"consequat et\",\n \"originalFileName\": \"magna eu id consequat\",\n \"size\": 1566384,\n \"type\": \"dolore sint nulla dolor\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"cupidatat4\": \"ullamco esse adipisicing\"\n },\n \"headers\": {\n \"in_c\": \"ut est enim Lorem id\",\n \"labore_b\": \"ipsum dolor dolore\"\n },\n \"host\": \"magna aute\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"consequat veniam\",\n \"metadata\": {\n \"Lorem2\": \"ea ullamco occaecat eiusmod\"\n },\n \"method\": \"cupi\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 9,\n \"persistCookies\": true,\n \"port\": -17384036,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eu_7a3\": \"Ut\",\n \"sintbbf\": \"pariatur non consectetur dolor\",\n \"enim__\": \"offic\"\n }\n },\n \"query\": {},\n \"servername\": \"nostrud consequat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": 89752470.07114398,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"i\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": true,\n \"initialNavigationTimeout\": 11733301,\n \"min_failure_duration\": -87057457,\n \"min_location_failed\": -52413111,\n \"monitor_name\": \"elit do reprehenderit laborum\",\n \"monitor_options\": {\n \"escalation_message\": \"anim commodo minim reprehenderit velit\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60519217,\n \"renotify_occurrences\": 227529\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 24009461,\n \"interval\": 97196217.90698808\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 413863\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -97266407,\n \"public_id\": \"in eu\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"deserunt et proident\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"in nisi fugiat\",\n \"timeout\": 90794253,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"voluptate incididunt aliqua sit\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"eiusmod proident enim Duis fugiat\",\n \"timeout\": -46669948,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a mobile test",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"initialApplicationArguments\": {\n \"proident_aec\": \"\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": \"Example test name\",\n \"options\": {\n \"device_ids\": [\n \"synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16\"\n ],\n \"tick_every\": 300,\n \"mobileApplication\": {\n \"applicationId\": \"00000000-0000-0000-0000-aaaaaaaaaaaa\",\n \"referenceId\": \"00000000-0000-0000-0000-aaaaaaaaaaab\",\n \"referenceType\": \"latest\"\n },\n \"allowApplicationCrash\": true,\n \"bindings\": [\n {\n \"principals\": [\n \"Duis eiusmod deserunt voluptate\",\n \"cillum voluptate adipisicing\"\n ],\n \"relation\": \"editor\"\n },\n {\n \"principals\": [\n \"ex cupidatat eiusmod qui Ut\",\n \"esse ad sint\"\n ],\n \"relation\": \"viewer\"\n }\n ],\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"defaultStepTimeout\": 282,\n \"disableAutoAcceptAlert\": false,\n \"min_failure_duration\": 545,\n \"monitor_name\": \"in aliqua cillum mollit\",\n \"monitor_options\": {\n \"escalation_message\": \"Duis non exercitation reprehenderit cillum\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 81883939,\n \"renotify_occurrences\": 25595889\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -79563905,\n \"interval\": -7235855.908941761\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"verbosity\": 3\n },\n \"type\": \"mobile\",\n \"message\": \"Notification message\",\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"greaterEquals\",\n \"delay\": 2461,\n \"direction\": \"left\",\n \"element\": {\n \"context\": \"velit nulla aliquip\",\n \"contextType\": \"native\",\n \"elementDescription\": \"tempor qui do\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -27475651.19994171,\n \"y\": 37092842.64996117\n },\n \"textContent\": \"irure dolore\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolore\"\n },\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolor consectetur dolore id tempor\"\n }\n ]\n },\n \"viewName\": \"ullamco nulla consequat fugiat\"\n },\n \"enabled\": false,\n \"maxScrolls\": 82877890,\n \"positions\": [\n {\n \"x\": -1078933.547199905,\n \"y\": 47306718.14290634\n },\n {\n \"x\": 22066932.774656877,\n \"y\": 5147201.988842264\n }\n ],\n \"subtestPublicId\": \"sit adipisicing anim aliqua\",\n \"value\": \"ex officia quis\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": false,\n \"x\": 62063395.20027858,\n \"y\": -33153663.255412266\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": false,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 2015556\n },\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"between\",\n \"delay\": 1067,\n \"direction\": \"down\",\n \"element\": {\n \"context\": \"ipsum magna veniam velit\",\n \"contextType\": \"native\",\n \"elementDescription\": \"deserunt incididunt aute\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -69073630.84124725,\n \"y\": -12491106.752787441\n },\n \"textContent\": \"ad\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"cupidatat consequat dolore\"\n },\n {\n \"type\": \"accessibility-id\",\n \"value\": \"officia in eiusmod dolor\"\n }\n ]\n },\n \"viewName\": \"sunt ut\"\n },\n \"enabled\": true,\n \"maxScrolls\": -60728375,\n \"positions\": [\n {\n \"x\": 46088589.93669158,\n \"y\": -37693278.52496176\n },\n {\n \"x\": 81015891.68192351,\n \"y\": 39635893.741861284\n }\n ],\n \"subtestPublicId\": \"in in\",\n \"value\": \"incididunt culpa\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": true,\n \"x\": 75815974.60309061,\n \"y\": 98520978.07872021\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": true,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 54845532\n }\n ],\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile"
]
},
"description": "Create a Synthetic mobile test."
},
"response": [
{
"name": "OK - Returns the created test details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"initialApplicationArguments\": {\n \"proident_aec\": \"\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": \"Example test name\",\n \"options\": {\n \"device_ids\": [\n \"synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16\"\n ],\n \"tick_every\": 300,\n \"mobileApplication\": {\n \"applicationId\": \"00000000-0000-0000-0000-aaaaaaaaaaaa\",\n \"referenceId\": \"00000000-0000-0000-0000-aaaaaaaaaaab\",\n \"referenceType\": \"latest\"\n },\n \"allowApplicationCrash\": true,\n \"bindings\": [\n {\n \"principals\": [\n \"Duis eiusmod deserunt voluptate\",\n \"cillum voluptate adipisicing\"\n ],\n \"relation\": \"editor\"\n },\n {\n \"principals\": [\n \"ex cupidatat eiusmod qui Ut\",\n \"esse ad sint\"\n ],\n \"relation\": \"viewer\"\n }\n ],\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"defaultStepTimeout\": 282,\n \"disableAutoAcceptAlert\": false,\n \"min_failure_duration\": 545,\n \"monitor_name\": \"in aliqua cillum mollit\",\n \"monitor_options\": {\n \"escalation_message\": \"Duis non exercitation reprehenderit cillum\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 81883939,\n \"renotify_occurrences\": 25595889\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -79563905,\n \"interval\": -7235855.908941761\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"verbosity\": 3\n },\n \"type\": \"mobile\",\n \"message\": \"Notification message\",\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"greaterEquals\",\n \"delay\": 2461,\n \"direction\": \"left\",\n \"element\": {\n \"context\": \"velit nulla aliquip\",\n \"contextType\": \"native\",\n \"elementDescription\": \"tempor qui do\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -27475651.19994171,\n \"y\": 37092842.64996117\n },\n \"textContent\": \"irure dolore\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolore\"\n },\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolor consectetur dolore id tempor\"\n }\n ]\n },\n \"viewName\": \"ullamco nulla consequat fugiat\"\n },\n \"enabled\": false,\n \"maxScrolls\": 82877890,\n \"positions\": [\n {\n \"x\": -1078933.547199905,\n \"y\": 47306718.14290634\n },\n {\n \"x\": 22066932.774656877,\n \"y\": 5147201.988842264\n }\n ],\n \"subtestPublicId\": \"sit adipisicing anim aliqua\",\n \"value\": \"ex officia quis\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": false,\n \"x\": 62063395.20027858,\n \"y\": -33153663.255412266\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": false,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 2015556\n },\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"between\",\n \"delay\": 1067,\n \"direction\": \"down\",\n \"element\": {\n \"context\": \"ipsum magna veniam velit\",\n \"contextType\": \"native\",\n \"elementDescription\": \"deserunt incididunt aute\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -69073630.84124725,\n \"y\": -12491106.752787441\n },\n \"textContent\": \"ad\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"cupidatat consequat dolore\"\n },\n {\n \"type\": \"accessibility-id\",\n \"value\": \"officia in eiusmod dolor\"\n }\n ]\n },\n \"viewName\": \"sunt ut\"\n },\n \"enabled\": true,\n \"maxScrolls\": -60728375,\n \"positions\": [\n {\n \"x\": 46088589.93669158,\n \"y\": -37693278.52496176\n },\n {\n \"x\": 81015891.68192351,\n \"y\": 39635893.741861284\n }\n ],\n \"subtestPublicId\": \"in in\",\n \"value\": \"incididunt culpa\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": true,\n \"x\": 75815974.60309061,\n \"y\": 98520978.07872021\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": true,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 54845532\n }\n ],\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"config\": {\n \"initialApplicationArguments\": {\n \"proident_aec\": \"\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": \"Example test name\",\n \"options\": {\n \"device_ids\": [\n \"synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16\"\n ],\n \"tick_every\": 300,\n \"mobileApplication\": {\n \"applicationId\": \"00000000-0000-0000-0000-aaaaaaaaaaaa\",\n \"referenceId\": \"00000000-0000-0000-0000-aaaaaaaaaaab\",\n \"referenceType\": \"latest\"\n },\n \"allowApplicationCrash\": true,\n \"bindings\": [\n {\n \"principals\": [\n \"Duis eiusmod deserunt voluptate\",\n \"cillum voluptate adipisicing\"\n ],\n \"relation\": \"editor\"\n },\n {\n \"principals\": [\n \"ex cupidatat eiusmod qui Ut\",\n \"esse ad sint\"\n ],\n \"relation\": \"viewer\"\n }\n ],\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"defaultStepTimeout\": 282,\n \"disableAutoAcceptAlert\": false,\n \"min_failure_duration\": 545,\n \"monitor_name\": \"in aliqua cillum mollit\",\n \"monitor_options\": {\n \"escalation_message\": \"Duis non exercitation reprehenderit cillum\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 81883939,\n \"renotify_occurrences\": 25595889\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -79563905,\n \"interval\": -7235855.908941761\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"verbosity\": 3\n },\n \"type\": \"mobile\",\n \"message\": \"Notification message\",\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"greaterEquals\",\n \"delay\": 2461,\n \"direction\": \"left\",\n \"element\": {\n \"context\": \"velit nulla aliquip\",\n \"contextType\": \"native\",\n \"elementDescription\": \"tempor qui do\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -27475651.19994171,\n \"y\": 37092842.64996117\n },\n \"textContent\": \"irure dolore\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolore\"\n },\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolor consectetur dolore id tempor\"\n }\n ]\n },\n \"viewName\": \"ullamco nulla consequat fugiat\"\n },\n \"enabled\": false,\n \"maxScrolls\": 82877890,\n \"positions\": [\n {\n \"x\": -1078933.547199905,\n \"y\": 47306718.14290634\n },\n {\n \"x\": 22066932.774656877,\n \"y\": 5147201.988842264\n }\n ],\n \"subtestPublicId\": \"sit adipisicing anim aliqua\",\n \"value\": \"ex officia quis\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": false,\n \"x\": 62063395.20027858,\n \"y\": -33153663.255412266\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": false,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 2015556\n },\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"between\",\n \"delay\": 1067,\n \"direction\": \"down\",\n \"element\": {\n \"context\": \"ipsum magna veniam velit\",\n \"contextType\": \"native\",\n \"elementDescription\": \"deserunt incididunt aute\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -69073630.84124725,\n \"y\": -12491106.752787441\n },\n \"textContent\": \"ad\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"cupidatat consequat dolore\"\n },\n {\n \"type\": \"accessibility-id\",\n \"value\": \"officia in eiusmod dolor\"\n }\n ]\n },\n \"viewName\": \"sunt ut\"\n },\n \"enabled\": true,\n \"maxScrolls\": -60728375,\n \"positions\": [\n {\n \"x\": 46088589.93669158,\n \"y\": -37693278.52496176\n },\n {\n \"x\": 81015891.68192351,\n \"y\": 39635893.741861284\n }\n ],\n \"subtestPublicId\": \"in in\",\n \"value\": \"incididunt culpa\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": true,\n \"x\": 75815974.60309061,\n \"y\": 98520978.07872021\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": true,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 54845532\n }\n ],\n \"tags\": [\n \"env:production\"\n ]\n}"
},
{
"name": "- JSON format is wrong\n- Creation failed",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"initialApplicationArguments\": {\n \"proident_aec\": \"\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": \"Example test name\",\n \"options\": {\n \"device_ids\": [\n \"synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16\"\n ],\n \"tick_every\": 300,\n \"mobileApplication\": {\n \"applicationId\": \"00000000-0000-0000-0000-aaaaaaaaaaaa\",\n \"referenceId\": \"00000000-0000-0000-0000-aaaaaaaaaaab\",\n \"referenceType\": \"latest\"\n },\n \"allowApplicationCrash\": true,\n \"bindings\": [\n {\n \"principals\": [\n \"Duis eiusmod deserunt voluptate\",\n \"cillum voluptate adipisicing\"\n ],\n \"relation\": \"editor\"\n },\n {\n \"principals\": [\n \"ex cupidatat eiusmod qui Ut\",\n \"esse ad sint\"\n ],\n \"relation\": \"viewer\"\n }\n ],\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"defaultStepTimeout\": 282,\n \"disableAutoAcceptAlert\": false,\n \"min_failure_duration\": 545,\n \"monitor_name\": \"in aliqua cillum mollit\",\n \"monitor_options\": {\n \"escalation_message\": \"Duis non exercitation reprehenderit cillum\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 81883939,\n \"renotify_occurrences\": 25595889\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -79563905,\n \"interval\": -7235855.908941761\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"verbosity\": 3\n },\n \"type\": \"mobile\",\n \"message\": \"Notification message\",\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"greaterEquals\",\n \"delay\": 2461,\n \"direction\": \"left\",\n \"element\": {\n \"context\": \"velit nulla aliquip\",\n \"contextType\": \"native\",\n \"elementDescription\": \"tempor qui do\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -27475651.19994171,\n \"y\": 37092842.64996117\n },\n \"textContent\": \"irure dolore\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolore\"\n },\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolor consectetur dolore id tempor\"\n }\n ]\n },\n \"viewName\": \"ullamco nulla consequat fugiat\"\n },\n \"enabled\": false,\n \"maxScrolls\": 82877890,\n \"positions\": [\n {\n \"x\": -1078933.547199905,\n \"y\": 47306718.14290634\n },\n {\n \"x\": 22066932.774656877,\n \"y\": 5147201.988842264\n }\n ],\n \"subtestPublicId\": \"sit adipisicing anim aliqua\",\n \"value\": \"ex officia quis\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": false,\n \"x\": 62063395.20027858,\n \"y\": -33153663.255412266\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": false,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 2015556\n },\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"between\",\n \"delay\": 1067,\n \"direction\": \"down\",\n \"element\": {\n \"context\": \"ipsum magna veniam velit\",\n \"contextType\": \"native\",\n \"elementDescription\": \"deserunt incididunt aute\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -69073630.84124725,\n \"y\": -12491106.752787441\n },\n \"textContent\": \"ad\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"cupidatat consequat dolore\"\n },\n {\n \"type\": \"accessibility-id\",\n \"value\": \"officia in eiusmod dolor\"\n }\n ]\n },\n \"viewName\": \"sunt ut\"\n },\n \"enabled\": true,\n \"maxScrolls\": -60728375,\n \"positions\": [\n {\n \"x\": 46088589.93669158,\n \"y\": -37693278.52496176\n },\n {\n \"x\": 81015891.68192351,\n \"y\": 39635893.741861284\n }\n ],\n \"subtestPublicId\": \"in in\",\n \"value\": \"incididunt culpa\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": true,\n \"x\": 75815974.60309061,\n \"y\": 98520978.07872021\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": true,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 54845532\n }\n ],\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Test quota is reached",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"initialApplicationArguments\": {\n \"proident_aec\": \"\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": \"Example test name\",\n \"options\": {\n \"device_ids\": [\n \"synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16\"\n ],\n \"tick_every\": 300,\n \"mobileApplication\": {\n \"applicationId\": \"00000000-0000-0000-0000-aaaaaaaaaaaa\",\n \"referenceId\": \"00000000-0000-0000-0000-aaaaaaaaaaab\",\n \"referenceType\": \"latest\"\n },\n \"allowApplicationCrash\": true,\n \"bindings\": [\n {\n \"principals\": [\n \"Duis eiusmod deserunt voluptate\",\n \"cillum voluptate adipisicing\"\n ],\n \"relation\": \"editor\"\n },\n {\n \"principals\": [\n \"ex cupidatat eiusmod qui Ut\",\n \"esse ad sint\"\n ],\n \"relation\": \"viewer\"\n }\n ],\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"defaultStepTimeout\": 282,\n \"disableAutoAcceptAlert\": false,\n \"min_failure_duration\": 545,\n \"monitor_name\": \"in aliqua cillum mollit\",\n \"monitor_options\": {\n \"escalation_message\": \"Duis non exercitation reprehenderit cillum\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 81883939,\n \"renotify_occurrences\": 25595889\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -79563905,\n \"interval\": -7235855.908941761\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"verbosity\": 3\n },\n \"type\": \"mobile\",\n \"message\": \"Notification message\",\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"greaterEquals\",\n \"delay\": 2461,\n \"direction\": \"left\",\n \"element\": {\n \"context\": \"velit nulla aliquip\",\n \"contextType\": \"native\",\n \"elementDescription\": \"tempor qui do\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -27475651.19994171,\n \"y\": 37092842.64996117\n },\n \"textContent\": \"irure dolore\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolore\"\n },\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolor consectetur dolore id tempor\"\n }\n ]\n },\n \"viewName\": \"ullamco nulla consequat fugiat\"\n },\n \"enabled\": false,\n \"maxScrolls\": 82877890,\n \"positions\": [\n {\n \"x\": -1078933.547199905,\n \"y\": 47306718.14290634\n },\n {\n \"x\": 22066932.774656877,\n \"y\": 5147201.988842264\n }\n ],\n \"subtestPublicId\": \"sit adipisicing anim aliqua\",\n \"value\": \"ex officia quis\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": false,\n \"x\": 62063395.20027858,\n \"y\": -33153663.255412266\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": false,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 2015556\n },\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"between\",\n \"delay\": 1067,\n \"direction\": \"down\",\n \"element\": {\n \"context\": \"ipsum magna veniam velit\",\n \"contextType\": \"native\",\n \"elementDescription\": \"deserunt incididunt aute\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -69073630.84124725,\n \"y\": -12491106.752787441\n },\n \"textContent\": \"ad\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"cupidatat consequat dolore\"\n },\n {\n \"type\": \"accessibility-id\",\n \"value\": \"officia in eiusmod dolor\"\n }\n ]\n },\n \"viewName\": \"sunt ut\"\n },\n \"enabled\": true,\n \"maxScrolls\": -60728375,\n \"positions\": [\n {\n \"x\": 46088589.93669158,\n \"y\": -37693278.52496176\n },\n {\n \"x\": 81015891.68192351,\n \"y\": 39635893.741861284\n }\n ],\n \"subtestPublicId\": \"in in\",\n \"value\": \"incididunt culpa\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": true,\n \"x\": 75815974.60309061,\n \"y\": 98520978.07872021\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": true,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 54845532\n }\n ],\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile"
]
}
},
"status": "Payment Required",
"code": 402,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"initialApplicationArguments\": {\n \"proident_aec\": \"\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": \"Example test name\",\n \"options\": {\n \"device_ids\": [\n \"synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16\"\n ],\n \"tick_every\": 300,\n \"mobileApplication\": {\n \"applicationId\": \"00000000-0000-0000-0000-aaaaaaaaaaaa\",\n \"referenceId\": \"00000000-0000-0000-0000-aaaaaaaaaaab\",\n \"referenceType\": \"latest\"\n },\n \"allowApplicationCrash\": true,\n \"bindings\": [\n {\n \"principals\": [\n \"Duis eiusmod deserunt voluptate\",\n \"cillum voluptate adipisicing\"\n ],\n \"relation\": \"editor\"\n },\n {\n \"principals\": [\n \"ex cupidatat eiusmod qui Ut\",\n \"esse ad sint\"\n ],\n \"relation\": \"viewer\"\n }\n ],\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"defaultStepTimeout\": 282,\n \"disableAutoAcceptAlert\": false,\n \"min_failure_duration\": 545,\n \"monitor_name\": \"in aliqua cillum mollit\",\n \"monitor_options\": {\n \"escalation_message\": \"Duis non exercitation reprehenderit cillum\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 81883939,\n \"renotify_occurrences\": 25595889\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -79563905,\n \"interval\": -7235855.908941761\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"verbosity\": 3\n },\n \"type\": \"mobile\",\n \"message\": \"Notification message\",\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"greaterEquals\",\n \"delay\": 2461,\n \"direction\": \"left\",\n \"element\": {\n \"context\": \"velit nulla aliquip\",\n \"contextType\": \"native\",\n \"elementDescription\": \"tempor qui do\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -27475651.19994171,\n \"y\": 37092842.64996117\n },\n \"textContent\": \"irure dolore\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolore\"\n },\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolor consectetur dolore id tempor\"\n }\n ]\n },\n \"viewName\": \"ullamco nulla consequat fugiat\"\n },\n \"enabled\": false,\n \"maxScrolls\": 82877890,\n \"positions\": [\n {\n \"x\": -1078933.547199905,\n \"y\": 47306718.14290634\n },\n {\n \"x\": 22066932.774656877,\n \"y\": 5147201.988842264\n }\n ],\n \"subtestPublicId\": \"sit adipisicing anim aliqua\",\n \"value\": \"ex officia quis\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": false,\n \"x\": 62063395.20027858,\n \"y\": -33153663.255412266\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": false,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 2015556\n },\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"between\",\n \"delay\": 1067,\n \"direction\": \"down\",\n \"element\": {\n \"context\": \"ipsum magna veniam velit\",\n \"contextType\": \"native\",\n \"elementDescription\": \"deserunt incididunt aute\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -69073630.84124725,\n \"y\": -12491106.752787441\n },\n \"textContent\": \"ad\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"cupidatat consequat dolore\"\n },\n {\n \"type\": \"accessibility-id\",\n \"value\": \"officia in eiusmod dolor\"\n }\n ]\n },\n \"viewName\": \"sunt ut\"\n },\n \"enabled\": true,\n \"maxScrolls\": -60728375,\n \"positions\": [\n {\n \"x\": 46088589.93669158,\n \"y\": -37693278.52496176\n },\n {\n \"x\": 81015891.68192351,\n \"y\": 39635893.741861284\n }\n ],\n \"subtestPublicId\": \"in in\",\n \"value\": \"incididunt culpa\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": true,\n \"x\": 75815974.60309061,\n \"y\": 98520978.07872021\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": true,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 54845532\n }\n ],\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"initialApplicationArguments\": {\n \"proident_aec\": \"\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": \"Example test name\",\n \"options\": {\n \"device_ids\": [\n \"synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16\"\n ],\n \"tick_every\": 300,\n \"mobileApplication\": {\n \"applicationId\": \"00000000-0000-0000-0000-aaaaaaaaaaaa\",\n \"referenceId\": \"00000000-0000-0000-0000-aaaaaaaaaaab\",\n \"referenceType\": \"latest\"\n },\n \"allowApplicationCrash\": true,\n \"bindings\": [\n {\n \"principals\": [\n \"Duis eiusmod deserunt voluptate\",\n \"cillum voluptate adipisicing\"\n ],\n \"relation\": \"editor\"\n },\n {\n \"principals\": [\n \"ex cupidatat eiusmod qui Ut\",\n \"esse ad sint\"\n ],\n \"relation\": \"viewer\"\n }\n ],\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"defaultStepTimeout\": 282,\n \"disableAutoAcceptAlert\": false,\n \"min_failure_duration\": 545,\n \"monitor_name\": \"in aliqua cillum mollit\",\n \"monitor_options\": {\n \"escalation_message\": \"Duis non exercitation reprehenderit cillum\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 81883939,\n \"renotify_occurrences\": 25595889\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -79563905,\n \"interval\": -7235855.908941761\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"verbosity\": 3\n },\n \"type\": \"mobile\",\n \"message\": \"Notification message\",\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"greaterEquals\",\n \"delay\": 2461,\n \"direction\": \"left\",\n \"element\": {\n \"context\": \"velit nulla aliquip\",\n \"contextType\": \"native\",\n \"elementDescription\": \"tempor qui do\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -27475651.19994171,\n \"y\": 37092842.64996117\n },\n \"textContent\": \"irure dolore\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolore\"\n },\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolor consectetur dolore id tempor\"\n }\n ]\n },\n \"viewName\": \"ullamco nulla consequat fugiat\"\n },\n \"enabled\": false,\n \"maxScrolls\": 82877890,\n \"positions\": [\n {\n \"x\": -1078933.547199905,\n \"y\": 47306718.14290634\n },\n {\n \"x\": 22066932.774656877,\n \"y\": 5147201.988842264\n }\n ],\n \"subtestPublicId\": \"sit adipisicing anim aliqua\",\n \"value\": \"ex officia quis\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": false,\n \"x\": 62063395.20027858,\n \"y\": -33153663.255412266\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": false,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 2015556\n },\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"between\",\n \"delay\": 1067,\n \"direction\": \"down\",\n \"element\": {\n \"context\": \"ipsum magna veniam velit\",\n \"contextType\": \"native\",\n \"elementDescription\": \"deserunt incididunt aute\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -69073630.84124725,\n \"y\": -12491106.752787441\n },\n \"textContent\": \"ad\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"cupidatat consequat dolore\"\n },\n {\n \"type\": \"accessibility-id\",\n \"value\": \"officia in eiusmod dolor\"\n }\n ]\n },\n \"viewName\": \"sunt ut\"\n },\n \"enabled\": true,\n \"maxScrolls\": -60728375,\n \"positions\": [\n {\n \"x\": 46088589.93669158,\n \"y\": -37693278.52496176\n },\n {\n \"x\": 81015891.68192351,\n \"y\": 39635893.741861284\n }\n ],\n \"subtestPublicId\": \"in in\",\n \"value\": \"incididunt culpa\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": true,\n \"x\": 75815974.60309061,\n \"y\": 98520978.07872021\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": true,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 54845532\n }\n ],\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Edit a Mobile test",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"initialApplicationArguments\": {\n \"proident_aec\": \"\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": \"Example test name\",\n \"options\": {\n \"device_ids\": [\n \"synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16\"\n ],\n \"tick_every\": 300,\n \"mobileApplication\": {\n \"applicationId\": \"00000000-0000-0000-0000-aaaaaaaaaaaa\",\n \"referenceId\": \"00000000-0000-0000-0000-aaaaaaaaaaab\",\n \"referenceType\": \"latest\"\n },\n \"allowApplicationCrash\": true,\n \"bindings\": [\n {\n \"principals\": [\n \"Duis eiusmod deserunt voluptate\",\n \"cillum voluptate adipisicing\"\n ],\n \"relation\": \"editor\"\n },\n {\n \"principals\": [\n \"ex cupidatat eiusmod qui Ut\",\n \"esse ad sint\"\n ],\n \"relation\": \"viewer\"\n }\n ],\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"defaultStepTimeout\": 282,\n \"disableAutoAcceptAlert\": false,\n \"min_failure_duration\": 545,\n \"monitor_name\": \"in aliqua cillum mollit\",\n \"monitor_options\": {\n \"escalation_message\": \"Duis non exercitation reprehenderit cillum\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 81883939,\n \"renotify_occurrences\": 25595889\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -79563905,\n \"interval\": -7235855.908941761\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"verbosity\": 3\n },\n \"type\": \"mobile\",\n \"message\": \"Notification message\",\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"greaterEquals\",\n \"delay\": 2461,\n \"direction\": \"left\",\n \"element\": {\n \"context\": \"velit nulla aliquip\",\n \"contextType\": \"native\",\n \"elementDescription\": \"tempor qui do\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -27475651.19994171,\n \"y\": 37092842.64996117\n },\n \"textContent\": \"irure dolore\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolore\"\n },\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolor consectetur dolore id tempor\"\n }\n ]\n },\n \"viewName\": \"ullamco nulla consequat fugiat\"\n },\n \"enabled\": false,\n \"maxScrolls\": 82877890,\n \"positions\": [\n {\n \"x\": -1078933.547199905,\n \"y\": 47306718.14290634\n },\n {\n \"x\": 22066932.774656877,\n \"y\": 5147201.988842264\n }\n ],\n \"subtestPublicId\": \"sit adipisicing anim aliqua\",\n \"value\": \"ex officia quis\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": false,\n \"x\": 62063395.20027858,\n \"y\": -33153663.255412266\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": false,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 2015556\n },\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"between\",\n \"delay\": 1067,\n \"direction\": \"down\",\n \"element\": {\n \"context\": \"ipsum magna veniam velit\",\n \"contextType\": \"native\",\n \"elementDescription\": \"deserunt incididunt aute\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -69073630.84124725,\n \"y\": -12491106.752787441\n },\n \"textContent\": \"ad\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"cupidatat consequat dolore\"\n },\n {\n \"type\": \"accessibility-id\",\n \"value\": \"officia in eiusmod dolor\"\n }\n ]\n },\n \"viewName\": \"sunt ut\"\n },\n \"enabled\": true,\n \"maxScrolls\": -60728375,\n \"positions\": [\n {\n \"x\": 46088589.93669158,\n \"y\": -37693278.52496176\n },\n {\n \"x\": 81015891.68192351,\n \"y\": 39635893.741861284\n }\n ],\n \"subtestPublicId\": \"in in\",\n \"value\": \"incididunt culpa\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": true,\n \"x\": 75815974.60309061,\n \"y\": 98520978.07872021\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": true,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 54845532\n }\n ],\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile",
":public_id"
],
"variable": [
{
"key": "public_id",
"value": "fugiat id"
}
]
},
"description": "Edit the configuration of a Synthetic Mobile test."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"initialApplicationArguments\": {\n \"proident_aec\": \"\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": \"Example test name\",\n \"options\": {\n \"device_ids\": [\n \"synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16\"\n ],\n \"tick_every\": 300,\n \"mobileApplication\": {\n \"applicationId\": \"00000000-0000-0000-0000-aaaaaaaaaaaa\",\n \"referenceId\": \"00000000-0000-0000-0000-aaaaaaaaaaab\",\n \"referenceType\": \"latest\"\n },\n \"allowApplicationCrash\": true,\n \"bindings\": [\n {\n \"principals\": [\n \"Duis eiusmod deserunt voluptate\",\n \"cillum voluptate adipisicing\"\n ],\n \"relation\": \"editor\"\n },\n {\n \"principals\": [\n \"ex cupidatat eiusmod qui Ut\",\n \"esse ad sint\"\n ],\n \"relation\": \"viewer\"\n }\n ],\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"defaultStepTimeout\": 282,\n \"disableAutoAcceptAlert\": false,\n \"min_failure_duration\": 545,\n \"monitor_name\": \"in aliqua cillum mollit\",\n \"monitor_options\": {\n \"escalation_message\": \"Duis non exercitation reprehenderit cillum\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 81883939,\n \"renotify_occurrences\": 25595889\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -79563905,\n \"interval\": -7235855.908941761\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"verbosity\": 3\n },\n \"type\": \"mobile\",\n \"message\": \"Notification message\",\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"greaterEquals\",\n \"delay\": 2461,\n \"direction\": \"left\",\n \"element\": {\n \"context\": \"velit nulla aliquip\",\n \"contextType\": \"native\",\n \"elementDescription\": \"tempor qui do\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -27475651.19994171,\n \"y\": 37092842.64996117\n },\n \"textContent\": \"irure dolore\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolore\"\n },\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolor consectetur dolore id tempor\"\n }\n ]\n },\n \"viewName\": \"ullamco nulla consequat fugiat\"\n },\n \"enabled\": false,\n \"maxScrolls\": 82877890,\n \"positions\": [\n {\n \"x\": -1078933.547199905,\n \"y\": 47306718.14290634\n },\n {\n \"x\": 22066932.774656877,\n \"y\": 5147201.988842264\n }\n ],\n \"subtestPublicId\": \"sit adipisicing anim aliqua\",\n \"value\": \"ex officia quis\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": false,\n \"x\": 62063395.20027858,\n \"y\": -33153663.255412266\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": false,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 2015556\n },\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"between\",\n \"delay\": 1067,\n \"direction\": \"down\",\n \"element\": {\n \"context\": \"ipsum magna veniam velit\",\n \"contextType\": \"native\",\n \"elementDescription\": \"deserunt incididunt aute\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -69073630.84124725,\n \"y\": -12491106.752787441\n },\n \"textContent\": \"ad\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"cupidatat consequat dolore\"\n },\n {\n \"type\": \"accessibility-id\",\n \"value\": \"officia in eiusmod dolor\"\n }\n ]\n },\n \"viewName\": \"sunt ut\"\n },\n \"enabled\": true,\n \"maxScrolls\": -60728375,\n \"positions\": [\n {\n \"x\": 46088589.93669158,\n \"y\": -37693278.52496176\n },\n {\n \"x\": 81015891.68192351,\n \"y\": 39635893.741861284\n }\n ],\n \"subtestPublicId\": \"in in\",\n \"value\": \"incididunt culpa\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": true,\n \"x\": 75815974.60309061,\n \"y\": 98520978.07872021\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": true,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 54845532\n }\n ],\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"config\": {\n \"initialApplicationArguments\": {\n \"proident_aec\": \"\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": \"Example test name\",\n \"options\": {\n \"device_ids\": [\n \"synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16\"\n ],\n \"tick_every\": 300,\n \"mobileApplication\": {\n \"applicationId\": \"00000000-0000-0000-0000-aaaaaaaaaaaa\",\n \"referenceId\": \"00000000-0000-0000-0000-aaaaaaaaaaab\",\n \"referenceType\": \"latest\"\n },\n \"allowApplicationCrash\": true,\n \"bindings\": [\n {\n \"principals\": [\n \"Duis eiusmod deserunt voluptate\",\n \"cillum voluptate adipisicing\"\n ],\n \"relation\": \"editor\"\n },\n {\n \"principals\": [\n \"ex cupidatat eiusmod qui Ut\",\n \"esse ad sint\"\n ],\n \"relation\": \"viewer\"\n }\n ],\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"defaultStepTimeout\": 282,\n \"disableAutoAcceptAlert\": false,\n \"min_failure_duration\": 545,\n \"monitor_name\": \"in aliqua cillum mollit\",\n \"monitor_options\": {\n \"escalation_message\": \"Duis non exercitation reprehenderit cillum\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 81883939,\n \"renotify_occurrences\": 25595889\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -79563905,\n \"interval\": -7235855.908941761\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"verbosity\": 3\n },\n \"type\": \"mobile\",\n \"message\": \"Notification message\",\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"greaterEquals\",\n \"delay\": 2461,\n \"direction\": \"left\",\n \"element\": {\n \"context\": \"velit nulla aliquip\",\n \"contextType\": \"native\",\n \"elementDescription\": \"tempor qui do\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -27475651.19994171,\n \"y\": 37092842.64996117\n },\n \"textContent\": \"irure dolore\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolore\"\n },\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolor consectetur dolore id tempor\"\n }\n ]\n },\n \"viewName\": \"ullamco nulla consequat fugiat\"\n },\n \"enabled\": false,\n \"maxScrolls\": 82877890,\n \"positions\": [\n {\n \"x\": -1078933.547199905,\n \"y\": 47306718.14290634\n },\n {\n \"x\": 22066932.774656877,\n \"y\": 5147201.988842264\n }\n ],\n \"subtestPublicId\": \"sit adipisicing anim aliqua\",\n \"value\": \"ex officia quis\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": false,\n \"x\": 62063395.20027858,\n \"y\": -33153663.255412266\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": false,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 2015556\n },\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"between\",\n \"delay\": 1067,\n \"direction\": \"down\",\n \"element\": {\n \"context\": \"ipsum magna veniam velit\",\n \"contextType\": \"native\",\n \"elementDescription\": \"deserunt incididunt aute\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -69073630.84124725,\n \"y\": -12491106.752787441\n },\n \"textContent\": \"ad\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"cupidatat consequat dolore\"\n },\n {\n \"type\": \"accessibility-id\",\n \"value\": \"officia in eiusmod dolor\"\n }\n ]\n },\n \"viewName\": \"sunt ut\"\n },\n \"enabled\": true,\n \"maxScrolls\": -60728375,\n \"positions\": [\n {\n \"x\": 46088589.93669158,\n \"y\": -37693278.52496176\n },\n {\n \"x\": 81015891.68192351,\n \"y\": 39635893.741861284\n }\n ],\n \"subtestPublicId\": \"in in\",\n \"value\": \"incididunt culpa\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": true,\n \"x\": 75815974.60309061,\n \"y\": 98520978.07872021\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": true,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 54845532\n }\n ],\n \"tags\": [\n \"env:production\"\n ]\n}"
},
{
"name": "- JSON format is wrong\n- Updating sub-type is forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"initialApplicationArguments\": {\n \"proident_aec\": \"\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": \"Example test name\",\n \"options\": {\n \"device_ids\": [\n \"synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16\"\n ],\n \"tick_every\": 300,\n \"mobileApplication\": {\n \"applicationId\": \"00000000-0000-0000-0000-aaaaaaaaaaaa\",\n \"referenceId\": \"00000000-0000-0000-0000-aaaaaaaaaaab\",\n \"referenceType\": \"latest\"\n },\n \"allowApplicationCrash\": true,\n \"bindings\": [\n {\n \"principals\": [\n \"Duis eiusmod deserunt voluptate\",\n \"cillum voluptate adipisicing\"\n ],\n \"relation\": \"editor\"\n },\n {\n \"principals\": [\n \"ex cupidatat eiusmod qui Ut\",\n \"esse ad sint\"\n ],\n \"relation\": \"viewer\"\n }\n ],\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"defaultStepTimeout\": 282,\n \"disableAutoAcceptAlert\": false,\n \"min_failure_duration\": 545,\n \"monitor_name\": \"in aliqua cillum mollit\",\n \"monitor_options\": {\n \"escalation_message\": \"Duis non exercitation reprehenderit cillum\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 81883939,\n \"renotify_occurrences\": 25595889\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -79563905,\n \"interval\": -7235855.908941761\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"verbosity\": 3\n },\n \"type\": \"mobile\",\n \"message\": \"Notification message\",\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"greaterEquals\",\n \"delay\": 2461,\n \"direction\": \"left\",\n \"element\": {\n \"context\": \"velit nulla aliquip\",\n \"contextType\": \"native\",\n \"elementDescription\": \"tempor qui do\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -27475651.19994171,\n \"y\": 37092842.64996117\n },\n \"textContent\": \"irure dolore\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolore\"\n },\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolor consectetur dolore id tempor\"\n }\n ]\n },\n \"viewName\": \"ullamco nulla consequat fugiat\"\n },\n \"enabled\": false,\n \"maxScrolls\": 82877890,\n \"positions\": [\n {\n \"x\": -1078933.547199905,\n \"y\": 47306718.14290634\n },\n {\n \"x\": 22066932.774656877,\n \"y\": 5147201.988842264\n }\n ],\n \"subtestPublicId\": \"sit adipisicing anim aliqua\",\n \"value\": \"ex officia quis\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": false,\n \"x\": 62063395.20027858,\n \"y\": -33153663.255412266\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": false,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 2015556\n },\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"between\",\n \"delay\": 1067,\n \"direction\": \"down\",\n \"element\": {\n \"context\": \"ipsum magna veniam velit\",\n \"contextType\": \"native\",\n \"elementDescription\": \"deserunt incididunt aute\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -69073630.84124725,\n \"y\": -12491106.752787441\n },\n \"textContent\": \"ad\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"cupidatat consequat dolore\"\n },\n {\n \"type\": \"accessibility-id\",\n \"value\": \"officia in eiusmod dolor\"\n }\n ]\n },\n \"viewName\": \"sunt ut\"\n },\n \"enabled\": true,\n \"maxScrolls\": -60728375,\n \"positions\": [\n {\n \"x\": 46088589.93669158,\n \"y\": -37693278.52496176\n },\n {\n \"x\": 81015891.68192351,\n \"y\": 39635893.741861284\n }\n ],\n \"subtestPublicId\": \"in in\",\n \"value\": \"incididunt culpa\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": true,\n \"x\": 75815974.60309061,\n \"y\": 98520978.07872021\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": true,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 54845532\n }\n ],\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"initialApplicationArguments\": {\n \"proident_aec\": \"\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": \"Example test name\",\n \"options\": {\n \"device_ids\": [\n \"synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16\"\n ],\n \"tick_every\": 300,\n \"mobileApplication\": {\n \"applicationId\": \"00000000-0000-0000-0000-aaaaaaaaaaaa\",\n \"referenceId\": \"00000000-0000-0000-0000-aaaaaaaaaaab\",\n \"referenceType\": \"latest\"\n },\n \"allowApplicationCrash\": true,\n \"bindings\": [\n {\n \"principals\": [\n \"Duis eiusmod deserunt voluptate\",\n \"cillum voluptate adipisicing\"\n ],\n \"relation\": \"editor\"\n },\n {\n \"principals\": [\n \"ex cupidatat eiusmod qui Ut\",\n \"esse ad sint\"\n ],\n \"relation\": \"viewer\"\n }\n ],\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"defaultStepTimeout\": 282,\n \"disableAutoAcceptAlert\": false,\n \"min_failure_duration\": 545,\n \"monitor_name\": \"in aliqua cillum mollit\",\n \"monitor_options\": {\n \"escalation_message\": \"Duis non exercitation reprehenderit cillum\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 81883939,\n \"renotify_occurrences\": 25595889\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -79563905,\n \"interval\": -7235855.908941761\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"verbosity\": 3\n },\n \"type\": \"mobile\",\n \"message\": \"Notification message\",\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"greaterEquals\",\n \"delay\": 2461,\n \"direction\": \"left\",\n \"element\": {\n \"context\": \"velit nulla aliquip\",\n \"contextType\": \"native\",\n \"elementDescription\": \"tempor qui do\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -27475651.19994171,\n \"y\": 37092842.64996117\n },\n \"textContent\": \"irure dolore\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolore\"\n },\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolor consectetur dolore id tempor\"\n }\n ]\n },\n \"viewName\": \"ullamco nulla consequat fugiat\"\n },\n \"enabled\": false,\n \"maxScrolls\": 82877890,\n \"positions\": [\n {\n \"x\": -1078933.547199905,\n \"y\": 47306718.14290634\n },\n {\n \"x\": 22066932.774656877,\n \"y\": 5147201.988842264\n }\n ],\n \"subtestPublicId\": \"sit adipisicing anim aliqua\",\n \"value\": \"ex officia quis\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": false,\n \"x\": 62063395.20027858,\n \"y\": -33153663.255412266\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": false,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 2015556\n },\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"between\",\n \"delay\": 1067,\n \"direction\": \"down\",\n \"element\": {\n \"context\": \"ipsum magna veniam velit\",\n \"contextType\": \"native\",\n \"elementDescription\": \"deserunt incididunt aute\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -69073630.84124725,\n \"y\": -12491106.752787441\n },\n \"textContent\": \"ad\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"cupidatat consequat dolore\"\n },\n {\n \"type\": \"accessibility-id\",\n \"value\": \"officia in eiusmod dolor\"\n }\n ]\n },\n \"viewName\": \"sunt ut\"\n },\n \"enabled\": true,\n \"maxScrolls\": -60728375,\n \"positions\": [\n {\n \"x\": 46088589.93669158,\n \"y\": -37693278.52496176\n },\n {\n \"x\": 81015891.68192351,\n \"y\": 39635893.741861284\n }\n ],\n \"subtestPublicId\": \"in in\",\n \"value\": \"incididunt culpa\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": true,\n \"x\": 75815974.60309061,\n \"y\": 98520978.07872021\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": true,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 54845532\n }\n ],\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "- Synthetic Monitoring is not activated for the user\n- Test is not owned by the user\n- Test can't be found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"initialApplicationArguments\": {\n \"proident_aec\": \"\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": \"Example test name\",\n \"options\": {\n \"device_ids\": [\n \"synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16\"\n ],\n \"tick_every\": 300,\n \"mobileApplication\": {\n \"applicationId\": \"00000000-0000-0000-0000-aaaaaaaaaaaa\",\n \"referenceId\": \"00000000-0000-0000-0000-aaaaaaaaaaab\",\n \"referenceType\": \"latest\"\n },\n \"allowApplicationCrash\": true,\n \"bindings\": [\n {\n \"principals\": [\n \"Duis eiusmod deserunt voluptate\",\n \"cillum voluptate adipisicing\"\n ],\n \"relation\": \"editor\"\n },\n {\n \"principals\": [\n \"ex cupidatat eiusmod qui Ut\",\n \"esse ad sint\"\n ],\n \"relation\": \"viewer\"\n }\n ],\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"defaultStepTimeout\": 282,\n \"disableAutoAcceptAlert\": false,\n \"min_failure_duration\": 545,\n \"monitor_name\": \"in aliqua cillum mollit\",\n \"monitor_options\": {\n \"escalation_message\": \"Duis non exercitation reprehenderit cillum\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 81883939,\n \"renotify_occurrences\": 25595889\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -79563905,\n \"interval\": -7235855.908941761\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"verbosity\": 3\n },\n \"type\": \"mobile\",\n \"message\": \"Notification message\",\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"greaterEquals\",\n \"delay\": 2461,\n \"direction\": \"left\",\n \"element\": {\n \"context\": \"velit nulla aliquip\",\n \"contextType\": \"native\",\n \"elementDescription\": \"tempor qui do\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -27475651.19994171,\n \"y\": 37092842.64996117\n },\n \"textContent\": \"irure dolore\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolore\"\n },\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolor consectetur dolore id tempor\"\n }\n ]\n },\n \"viewName\": \"ullamco nulla consequat fugiat\"\n },\n \"enabled\": false,\n \"maxScrolls\": 82877890,\n \"positions\": [\n {\n \"x\": -1078933.547199905,\n \"y\": 47306718.14290634\n },\n {\n \"x\": 22066932.774656877,\n \"y\": 5147201.988842264\n }\n ],\n \"subtestPublicId\": \"sit adipisicing anim aliqua\",\n \"value\": \"ex officia quis\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": false,\n \"x\": 62063395.20027858,\n \"y\": -33153663.255412266\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": false,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 2015556\n },\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"between\",\n \"delay\": 1067,\n \"direction\": \"down\",\n \"element\": {\n \"context\": \"ipsum magna veniam velit\",\n \"contextType\": \"native\",\n \"elementDescription\": \"deserunt incididunt aute\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -69073630.84124725,\n \"y\": -12491106.752787441\n },\n \"textContent\": \"ad\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"cupidatat consequat dolore\"\n },\n {\n \"type\": \"accessibility-id\",\n \"value\": \"officia in eiusmod dolor\"\n }\n ]\n },\n \"viewName\": \"sunt ut\"\n },\n \"enabled\": true,\n \"maxScrolls\": -60728375,\n \"positions\": [\n {\n \"x\": 46088589.93669158,\n \"y\": -37693278.52496176\n },\n {\n \"x\": 81015891.68192351,\n \"y\": 39635893.741861284\n }\n ],\n \"subtestPublicId\": \"in in\",\n \"value\": \"incididunt culpa\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": true,\n \"x\": 75815974.60309061,\n \"y\": 98520978.07872021\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": true,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 54845532\n }\n ],\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"initialApplicationArguments\": {\n \"proident_aec\": \"\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": \"Example test name\",\n \"options\": {\n \"device_ids\": [\n \"synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16\"\n ],\n \"tick_every\": 300,\n \"mobileApplication\": {\n \"applicationId\": \"00000000-0000-0000-0000-aaaaaaaaaaaa\",\n \"referenceId\": \"00000000-0000-0000-0000-aaaaaaaaaaab\",\n \"referenceType\": \"latest\"\n },\n \"allowApplicationCrash\": true,\n \"bindings\": [\n {\n \"principals\": [\n \"Duis eiusmod deserunt voluptate\",\n \"cillum voluptate adipisicing\"\n ],\n \"relation\": \"editor\"\n },\n {\n \"principals\": [\n \"ex cupidatat eiusmod qui Ut\",\n \"esse ad sint\"\n ],\n \"relation\": \"viewer\"\n }\n ],\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"defaultStepTimeout\": 282,\n \"disableAutoAcceptAlert\": false,\n \"min_failure_duration\": 545,\n \"monitor_name\": \"in aliqua cillum mollit\",\n \"monitor_options\": {\n \"escalation_message\": \"Duis non exercitation reprehenderit cillum\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 81883939,\n \"renotify_occurrences\": 25595889\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -79563905,\n \"interval\": -7235855.908941761\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"verbosity\": 3\n },\n \"type\": \"mobile\",\n \"message\": \"Notification message\",\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"greaterEquals\",\n \"delay\": 2461,\n \"direction\": \"left\",\n \"element\": {\n \"context\": \"velit nulla aliquip\",\n \"contextType\": \"native\",\n \"elementDescription\": \"tempor qui do\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -27475651.19994171,\n \"y\": 37092842.64996117\n },\n \"textContent\": \"irure dolore\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolore\"\n },\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolor consectetur dolore id tempor\"\n }\n ]\n },\n \"viewName\": \"ullamco nulla consequat fugiat\"\n },\n \"enabled\": false,\n \"maxScrolls\": 82877890,\n \"positions\": [\n {\n \"x\": -1078933.547199905,\n \"y\": 47306718.14290634\n },\n {\n \"x\": 22066932.774656877,\n \"y\": 5147201.988842264\n }\n ],\n \"subtestPublicId\": \"sit adipisicing anim aliqua\",\n \"value\": \"ex officia quis\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": false,\n \"x\": 62063395.20027858,\n \"y\": -33153663.255412266\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": false,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 2015556\n },\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"between\",\n \"delay\": 1067,\n \"direction\": \"down\",\n \"element\": {\n \"context\": \"ipsum magna veniam velit\",\n \"contextType\": \"native\",\n \"elementDescription\": \"deserunt incididunt aute\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -69073630.84124725,\n \"y\": -12491106.752787441\n },\n \"textContent\": \"ad\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"cupidatat consequat dolore\"\n },\n {\n \"type\": \"accessibility-id\",\n \"value\": \"officia in eiusmod dolor\"\n }\n ]\n },\n \"viewName\": \"sunt ut\"\n },\n \"enabled\": true,\n \"maxScrolls\": -60728375,\n \"positions\": [\n {\n \"x\": 46088589.93669158,\n \"y\": -37693278.52496176\n },\n {\n \"x\": 81015891.68192351,\n \"y\": 39635893.741861284\n }\n ],\n \"subtestPublicId\": \"in in\",\n \"value\": \"incididunt culpa\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": true,\n \"x\": 75815974.60309061,\n \"y\": 98520978.07872021\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": true,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 54845532\n }\n ],\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Edit an API test",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Example test name\",\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"options\": {\n \"accept_self_signed\": false,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": true,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": false,\n \"disableCors\": true,\n \"disableCsp\": false,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -37997999,\n \"min_failure_duration\": 77817896,\n \"min_location_failed\": 38023074,\n \"monitor_name\": \"cupidatat dolore non ut\",\n \"monitor_options\": {\n \"escalation_message\": \"veniam incididunt voluptate\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 33247447,\n \"renotify_occurrences\": -71601604\n },\n \"monitor_priority\": 4,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -63582187,\n \"interval\": 46016019.6128844\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 363049\n },\n \"type\": \"api\",\n \"message\": \"Notification message\",\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id",
"value": "fugiat id"
}
]
},
"description": "Edit the configuration of a Synthetic API test."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Example test name\",\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"options\": {\n \"accept_self_signed\": false,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": true,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": false,\n \"disableCors\": true,\n \"disableCsp\": false,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -37997999,\n \"min_failure_duration\": 77817896,\n \"min_location_failed\": 38023074,\n \"monitor_name\": \"cupidatat dolore non ut\",\n \"monitor_options\": {\n \"escalation_message\": \"veniam incididunt voluptate\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 33247447,\n \"renotify_occurrences\": -71601604\n },\n \"monitor_priority\": 4,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -63582187,\n \"interval\": 46016019.6128844\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 363049\n },\n \"type\": \"api\",\n \"message\": \"Notification message\",\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"Example test name\",\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"options\": {\n \"accept_self_signed\": false,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": true,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": false,\n \"disableCors\": true,\n \"disableCsp\": false,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -37997999,\n \"min_failure_duration\": 77817896,\n \"min_location_failed\": 38023074,\n \"monitor_name\": \"cupidatat dolore non ut\",\n \"monitor_options\": {\n \"escalation_message\": \"veniam incididunt voluptate\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 33247447,\n \"renotify_occurrences\": -71601604\n },\n \"monitor_priority\": 4,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -63582187,\n \"interval\": 46016019.6128844\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 363049\n },\n \"type\": \"api\",\n \"message\": \"Notification message\",\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\n ]\n}"
},
{
"name": "- JSON format is wrong\n- Updating sub-type is forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Example test name\",\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"options\": {\n \"accept_self_signed\": false,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": true,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": false,\n \"disableCors\": true,\n \"disableCsp\": false,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -37997999,\n \"min_failure_duration\": 77817896,\n \"min_location_failed\": 38023074,\n \"monitor_name\": \"cupidatat dolore non ut\",\n \"monitor_options\": {\n \"escalation_message\": \"veniam incididunt voluptate\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 33247447,\n \"renotify_occurrences\": -71601604\n },\n \"monitor_priority\": 4,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -63582187,\n \"interval\": 46016019.6128844\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 363049\n },\n \"type\": \"api\",\n \"message\": \"Notification message\",\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Example test name\",\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"options\": {\n \"accept_self_signed\": false,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": true,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": false,\n \"disableCors\": true,\n \"disableCsp\": false,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -37997999,\n \"min_failure_duration\": 77817896,\n \"min_location_failed\": 38023074,\n \"monitor_name\": \"cupidatat dolore non ut\",\n \"monitor_options\": {\n \"escalation_message\": \"veniam incididunt voluptate\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 33247447,\n \"renotify_occurrences\": -71601604\n },\n \"monitor_priority\": 4,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -63582187,\n \"interval\": 46016019.6128844\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 363049\n },\n \"type\": \"api\",\n \"message\": \"Notification message\",\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "- Synthetic Monitoring is not activated for the user\n- Test is not owned by the user\n- Test can't be found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Example test name\",\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"options\": {\n \"accept_self_signed\": false,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": true,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": false,\n \"disableCors\": true,\n \"disableCsp\": false,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -37997999,\n \"min_failure_duration\": 77817896,\n \"min_location_failed\": 38023074,\n \"monitor_name\": \"cupidatat dolore non ut\",\n \"monitor_options\": {\n \"escalation_message\": \"veniam incididunt voluptate\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 33247447,\n \"renotify_occurrences\": -71601604\n },\n \"monitor_priority\": 4,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -63582187,\n \"interval\": 46016019.6128844\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 363049\n },\n \"type\": \"api\",\n \"message\": \"Notification message\",\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Example test name\",\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"options\": {\n \"accept_self_signed\": false,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": true,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": false,\n \"disableCors\": true,\n \"disableCsp\": false,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -37997999,\n \"min_failure_duration\": 77817896,\n \"min_location_failed\": 38023074,\n \"monitor_name\": \"cupidatat dolore non ut\",\n \"monitor_options\": {\n \"escalation_message\": \"veniam incididunt voluptate\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 33247447,\n \"renotify_occurrences\": -71601604\n },\n \"monitor_priority\": 4,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -63582187,\n \"interval\": 46016019.6128844\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 363049\n },\n \"type\": \"api\",\n \"message\": \"Notification message\",\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Edit a browser test",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"consectetur magna dolor\",\n \"filename\": \"ex\",\n \"updatedAt\": \"Excepteur consequat\"\n },\n \"key\": {\n \"content\": \"voluptate in do ut\",\n \"filename\": \"ut sunt exercitation incididunt aliqua\",\n \"updatedAt\": \"in ex\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"exercitation Ut qui incididunt\",\n \"compressedProtoFile\": \"Excepteur labore quis\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"labore exercitation\",\n \"dnsServerPort\": -69565807,\n \"files\": [\n {\n \"bucketKey\": \"fugiat magna proident\",\n \"content\": \"laborum sit incididunt officia proident\",\n \"name\": \"dolore Duis in esse\",\n \"originalFileName\": \"sint culpa nulla ea\",\n \"size\": 445243,\n \"type\": \"proident eu occaecat laborum ea\"\n },\n {\n \"bucketKey\": \"irure laborum ipsum cupidatat\",\n \"content\": \"esse eu deserunt ut\",\n \"name\": \"consequat et\",\n \"originalFileName\": \"magna eu id consequat\",\n \"size\": 1566384,\n \"type\": \"dolore sint nulla dolor\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"cupidatat4\": \"ullamco esse adipisicing\"\n },\n \"headers\": {\n \"in_c\": \"ut est enim Lorem id\",\n \"labore_b\": \"ipsum dolor dolore\"\n },\n \"host\": \"magna aute\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"consequat veniam\",\n \"metadata\": {\n \"Lorem2\": \"ea ullamco occaecat eiusmod\"\n },\n \"method\": \"cupi\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 9,\n \"persistCookies\": true,\n \"port\": -17384036,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eu_7a3\": \"Ut\",\n \"sintbbf\": \"pariatur non consectetur dolor\",\n \"enim__\": \"offic\"\n }\n },\n \"query\": {},\n \"servername\": \"nostrud consequat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": 89752470.07114398,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"i\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": true,\n \"initialNavigationTimeout\": 11733301,\n \"min_failure_duration\": -87057457,\n \"min_location_failed\": -52413111,\n \"monitor_name\": \"elit do reprehenderit laborum\",\n \"monitor_options\": {\n \"escalation_message\": \"anim commodo minim reprehenderit velit\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60519217,\n \"renotify_occurrences\": 227529\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 24009461,\n \"interval\": 97196217.90698808\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 413863\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -97266407,\n \"public_id\": \"in eu\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"deserunt et proident\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"in nisi fugiat\",\n \"timeout\": 90794253,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"voluptate incididunt aliqua sit\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"eiusmod proident enim Duis fugiat\",\n \"timeout\": -46669948,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id"
],
"variable": [
{
"key": "public_id",
"value": "fugiat id"
}
]
},
"description": "Edit the configuration of a Synthetic browser test."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"consectetur magna dolor\",\n \"filename\": \"ex\",\n \"updatedAt\": \"Excepteur consequat\"\n },\n \"key\": {\n \"content\": \"voluptate in do ut\",\n \"filename\": \"ut sunt exercitation incididunt aliqua\",\n \"updatedAt\": \"in ex\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"exercitation Ut qui incididunt\",\n \"compressedProtoFile\": \"Excepteur labore quis\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"labore exercitation\",\n \"dnsServerPort\": -69565807,\n \"files\": [\n {\n \"bucketKey\": \"fugiat magna proident\",\n \"content\": \"laborum sit incididunt officia proident\",\n \"name\": \"dolore Duis in esse\",\n \"originalFileName\": \"sint culpa nulla ea\",\n \"size\": 445243,\n \"type\": \"proident eu occaecat laborum ea\"\n },\n {\n \"bucketKey\": \"irure laborum ipsum cupidatat\",\n \"content\": \"esse eu deserunt ut\",\n \"name\": \"consequat et\",\n \"originalFileName\": \"magna eu id consequat\",\n \"size\": 1566384,\n \"type\": \"dolore sint nulla dolor\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"cupidatat4\": \"ullamco esse adipisicing\"\n },\n \"headers\": {\n \"in_c\": \"ut est enim Lorem id\",\n \"labore_b\": \"ipsum dolor dolore\"\n },\n \"host\": \"magna aute\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"consequat veniam\",\n \"metadata\": {\n \"Lorem2\": \"ea ullamco occaecat eiusmod\"\n },\n \"method\": \"cupi\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 9,\n \"persistCookies\": true,\n \"port\": -17384036,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eu_7a3\": \"Ut\",\n \"sintbbf\": \"pariatur non consectetur dolor\",\n \"enim__\": \"offic\"\n }\n },\n \"query\": {},\n \"servername\": \"nostrud consequat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": 89752470.07114398,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"i\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": true,\n \"initialNavigationTimeout\": 11733301,\n \"min_failure_duration\": -87057457,\n \"min_location_failed\": -52413111,\n \"monitor_name\": \"elit do reprehenderit laborum\",\n \"monitor_options\": {\n \"escalation_message\": \"anim commodo minim reprehenderit velit\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60519217,\n \"renotify_occurrences\": 227529\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 24009461,\n \"interval\": 97196217.90698808\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 413863\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -97266407,\n \"public_id\": \"in eu\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"deserunt et proident\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"in nisi fugiat\",\n \"timeout\": 90794253,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"voluptate incididunt aliqua sit\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"eiusmod proident enim Duis fugiat\",\n \"timeout\": -46669948,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"consectetur magna dolor\",\n \"filename\": \"ex\",\n \"updatedAt\": \"Excepteur consequat\"\n },\n \"key\": {\n \"content\": \"voluptate in do ut\",\n \"filename\": \"ut sunt exercitation incididunt aliqua\",\n \"updatedAt\": \"in ex\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"exercitation Ut qui incididunt\",\n \"compressedProtoFile\": \"Excepteur labore quis\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"labore exercitation\",\n \"dnsServerPort\": -69565807,\n \"files\": [\n {\n \"bucketKey\": \"fugiat magna proident\",\n \"content\": \"laborum sit incididunt officia proident\",\n \"name\": \"dolore Duis in esse\",\n \"originalFileName\": \"sint culpa nulla ea\",\n \"size\": 445243,\n \"type\": \"proident eu occaecat laborum ea\"\n },\n {\n \"bucketKey\": \"irure laborum ipsum cupidatat\",\n \"content\": \"esse eu deserunt ut\",\n \"name\": \"consequat et\",\n \"originalFileName\": \"magna eu id consequat\",\n \"size\": 1566384,\n \"type\": \"dolore sint nulla dolor\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"cupidatat4\": \"ullamco esse adipisicing\"\n },\n \"headers\": {\n \"in_c\": \"ut est enim Lorem id\",\n \"labore_b\": \"ipsum dolor dolore\"\n },\n \"host\": \"magna aute\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"consequat veniam\",\n \"metadata\": {\n \"Lorem2\": \"ea ullamco occaecat eiusmod\"\n },\n \"method\": \"cupi\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 9,\n \"persistCookies\": true,\n \"port\": -17384036,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eu_7a3\": \"Ut\",\n \"sintbbf\": \"pariatur non consectetur dolor\",\n \"enim__\": \"offic\"\n }\n },\n \"query\": {},\n \"servername\": \"nostrud consequat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": 89752470.07114398,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"i\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": true,\n \"initialNavigationTimeout\": 11733301,\n \"min_failure_duration\": -87057457,\n \"min_location_failed\": -52413111,\n \"monitor_name\": \"elit do reprehenderit laborum\",\n \"monitor_options\": {\n \"escalation_message\": \"anim commodo minim reprehenderit velit\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60519217,\n \"renotify_occurrences\": 227529\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 24009461,\n \"interval\": 97196217.90698808\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 413863\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -97266407,\n \"public_id\": \"in eu\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"deserunt et proident\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"in nisi fugiat\",\n \"timeout\": 90794253,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"voluptate incididunt aliqua sit\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"eiusmod proident enim Duis fugiat\",\n \"timeout\": -46669948,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}"
},
{
"name": "- JSON format is wrong\n- Updating sub-type is forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"consectetur magna dolor\",\n \"filename\": \"ex\",\n \"updatedAt\": \"Excepteur consequat\"\n },\n \"key\": {\n \"content\": \"voluptate in do ut\",\n \"filename\": \"ut sunt exercitation incididunt aliqua\",\n \"updatedAt\": \"in ex\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"exercitation Ut qui incididunt\",\n \"compressedProtoFile\": \"Excepteur labore quis\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"labore exercitation\",\n \"dnsServerPort\": -69565807,\n \"files\": [\n {\n \"bucketKey\": \"fugiat magna proident\",\n \"content\": \"laborum sit incididunt officia proident\",\n \"name\": \"dolore Duis in esse\",\n \"originalFileName\": \"sint culpa nulla ea\",\n \"size\": 445243,\n \"type\": \"proident eu occaecat laborum ea\"\n },\n {\n \"bucketKey\": \"irure laborum ipsum cupidatat\",\n \"content\": \"esse eu deserunt ut\",\n \"name\": \"consequat et\",\n \"originalFileName\": \"magna eu id consequat\",\n \"size\": 1566384,\n \"type\": \"dolore sint nulla dolor\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"cupidatat4\": \"ullamco esse adipisicing\"\n },\n \"headers\": {\n \"in_c\": \"ut est enim Lorem id\",\n \"labore_b\": \"ipsum dolor dolore\"\n },\n \"host\": \"magna aute\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"consequat veniam\",\n \"metadata\": {\n \"Lorem2\": \"ea ullamco occaecat eiusmod\"\n },\n \"method\": \"cupi\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 9,\n \"persistCookies\": true,\n \"port\": -17384036,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eu_7a3\": \"Ut\",\n \"sintbbf\": \"pariatur non consectetur dolor\",\n \"enim__\": \"offic\"\n }\n },\n \"query\": {},\n \"servername\": \"nostrud consequat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": 89752470.07114398,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"i\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": true,\n \"initialNavigationTimeout\": 11733301,\n \"min_failure_duration\": -87057457,\n \"min_location_failed\": -52413111,\n \"monitor_name\": \"elit do reprehenderit laborum\",\n \"monitor_options\": {\n \"escalation_message\": \"anim commodo minim reprehenderit velit\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60519217,\n \"renotify_occurrences\": 227529\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 24009461,\n \"interval\": 97196217.90698808\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 413863\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -97266407,\n \"public_id\": \"in eu\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"deserunt et proident\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"in nisi fugiat\",\n \"timeout\": 90794253,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"voluptate incididunt aliqua sit\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"eiusmod proident enim Duis fugiat\",\n \"timeout\": -46669948,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"consectetur magna dolor\",\n \"filename\": \"ex\",\n \"updatedAt\": \"Excepteur consequat\"\n },\n \"key\": {\n \"content\": \"voluptate in do ut\",\n \"filename\": \"ut sunt exercitation incididunt aliqua\",\n \"updatedAt\": \"in ex\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"exercitation Ut qui incididunt\",\n \"compressedProtoFile\": \"Excepteur labore quis\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"labore exercitation\",\n \"dnsServerPort\": -69565807,\n \"files\": [\n {\n \"bucketKey\": \"fugiat magna proident\",\n \"content\": \"laborum sit incididunt officia proident\",\n \"name\": \"dolore Duis in esse\",\n \"originalFileName\": \"sint culpa nulla ea\",\n \"size\": 445243,\n \"type\": \"proident eu occaecat laborum ea\"\n },\n {\n \"bucketKey\": \"irure laborum ipsum cupidatat\",\n \"content\": \"esse eu deserunt ut\",\n \"name\": \"consequat et\",\n \"originalFileName\": \"magna eu id consequat\",\n \"size\": 1566384,\n \"type\": \"dolore sint nulla dolor\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"cupidatat4\": \"ullamco esse adipisicing\"\n },\n \"headers\": {\n \"in_c\": \"ut est enim Lorem id\",\n \"labore_b\": \"ipsum dolor dolore\"\n },\n \"host\": \"magna aute\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"consequat veniam\",\n \"metadata\": {\n \"Lorem2\": \"ea ullamco occaecat eiusmod\"\n },\n \"method\": \"cupi\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 9,\n \"persistCookies\": true,\n \"port\": -17384036,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eu_7a3\": \"Ut\",\n \"sintbbf\": \"pariatur non consectetur dolor\",\n \"enim__\": \"offic\"\n }\n },\n \"query\": {},\n \"servername\": \"nostrud consequat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": 89752470.07114398,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"i\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": true,\n \"initialNavigationTimeout\": 11733301,\n \"min_failure_duration\": -87057457,\n \"min_location_failed\": -52413111,\n \"monitor_name\": \"elit do reprehenderit laborum\",\n \"monitor_options\": {\n \"escalation_message\": \"anim commodo minim reprehenderit velit\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60519217,\n \"renotify_occurrences\": 227529\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 24009461,\n \"interval\": 97196217.90698808\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 413863\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -97266407,\n \"public_id\": \"in eu\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"deserunt et proident\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"in nisi fugiat\",\n \"timeout\": 90794253,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"voluptate incididunt aliqua sit\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"eiusmod proident enim Duis fugiat\",\n \"timeout\": -46669948,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "- Synthetic Monitoring is not activated for the user\n- Test is not owned by the user\n- Test can't be found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"consectetur magna dolor\",\n \"filename\": \"ex\",\n \"updatedAt\": \"Excepteur consequat\"\n },\n \"key\": {\n \"content\": \"voluptate in do ut\",\n \"filename\": \"ut sunt exercitation incididunt aliqua\",\n \"updatedAt\": \"in ex\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"exercitation Ut qui incididunt\",\n \"compressedProtoFile\": \"Excepteur labore quis\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"labore exercitation\",\n \"dnsServerPort\": -69565807,\n \"files\": [\n {\n \"bucketKey\": \"fugiat magna proident\",\n \"content\": \"laborum sit incididunt officia proident\",\n \"name\": \"dolore Duis in esse\",\n \"originalFileName\": \"sint culpa nulla ea\",\n \"size\": 445243,\n \"type\": \"proident eu occaecat laborum ea\"\n },\n {\n \"bucketKey\": \"irure laborum ipsum cupidatat\",\n \"content\": \"esse eu deserunt ut\",\n \"name\": \"consequat et\",\n \"originalFileName\": \"magna eu id consequat\",\n \"size\": 1566384,\n \"type\": \"dolore sint nulla dolor\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"cupidatat4\": \"ullamco esse adipisicing\"\n },\n \"headers\": {\n \"in_c\": \"ut est enim Lorem id\",\n \"labore_b\": \"ipsum dolor dolore\"\n },\n \"host\": \"magna aute\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"consequat veniam\",\n \"metadata\": {\n \"Lorem2\": \"ea ullamco occaecat eiusmod\"\n },\n \"method\": \"cupi\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 9,\n \"persistCookies\": true,\n \"port\": -17384036,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eu_7a3\": \"Ut\",\n \"sintbbf\": \"pariatur non consectetur dolor\",\n \"enim__\": \"offic\"\n }\n },\n \"query\": {},\n \"servername\": \"nostrud consequat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": 89752470.07114398,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"i\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": true,\n \"initialNavigationTimeout\": 11733301,\n \"min_failure_duration\": -87057457,\n \"min_location_failed\": -52413111,\n \"monitor_name\": \"elit do reprehenderit laborum\",\n \"monitor_options\": {\n \"escalation_message\": \"anim commodo minim reprehenderit velit\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60519217,\n \"renotify_occurrences\": 227529\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 24009461,\n \"interval\": 97196217.90698808\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 413863\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -97266407,\n \"public_id\": \"in eu\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"deserunt et proident\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"in nisi fugiat\",\n \"timeout\": 90794253,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"voluptate incididunt aliqua sit\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"eiusmod proident enim Duis fugiat\",\n \"timeout\": -46669948,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"consectetur magna dolor\",\n \"filename\": \"ex\",\n \"updatedAt\": \"Excepteur consequat\"\n },\n \"key\": {\n \"content\": \"voluptate in do ut\",\n \"filename\": \"ut sunt exercitation incididunt aliqua\",\n \"updatedAt\": \"in ex\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"exercitation Ut qui incididunt\",\n \"compressedProtoFile\": \"Excepteur labore quis\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"labore exercitation\",\n \"dnsServerPort\": -69565807,\n \"files\": [\n {\n \"bucketKey\": \"fugiat magna proident\",\n \"content\": \"laborum sit incididunt officia proident\",\n \"name\": \"dolore Duis in esse\",\n \"originalFileName\": \"sint culpa nulla ea\",\n \"size\": 445243,\n \"type\": \"proident eu occaecat laborum ea\"\n },\n {\n \"bucketKey\": \"irure laborum ipsum cupidatat\",\n \"content\": \"esse eu deserunt ut\",\n \"name\": \"consequat et\",\n \"originalFileName\": \"magna eu id consequat\",\n \"size\": 1566384,\n \"type\": \"dolore sint nulla dolor\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"cupidatat4\": \"ullamco esse adipisicing\"\n },\n \"headers\": {\n \"in_c\": \"ut est enim Lorem id\",\n \"labore_b\": \"ipsum dolor dolore\"\n },\n \"host\": \"magna aute\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"consequat veniam\",\n \"metadata\": {\n \"Lorem2\": \"ea ullamco occaecat eiusmod\"\n },\n \"method\": \"cupi\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 9,\n \"persistCookies\": true,\n \"port\": -17384036,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eu_7a3\": \"Ut\",\n \"sintbbf\": \"pariatur non consectetur dolor\",\n \"enim__\": \"offic\"\n }\n },\n \"query\": {},\n \"servername\": \"nostrud consequat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": 89752470.07114398,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"i\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": true,\n \"initialNavigationTimeout\": 11733301,\n \"min_failure_duration\": -87057457,\n \"min_location_failed\": -52413111,\n \"monitor_name\": \"elit do reprehenderit laborum\",\n \"monitor_options\": {\n \"escalation_message\": \"anim commodo minim reprehenderit velit\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60519217,\n \"renotify_occurrences\": 227529\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 24009461,\n \"interval\": 97196217.90698808\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 413863\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -97266407,\n \"public_id\": \"in eu\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"deserunt et proident\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"in nisi fugiat\",\n \"timeout\": 90794253,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"voluptate incididunt aliqua sit\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"eiusmod proident enim Duis fugiat\",\n \"timeout\": -46669948,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Patch a Synthetic test",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"New test name\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"/config/assertions/0\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id"
],
"variable": [
{
"key": "public_id",
"value": "fugiat id"
}
]
},
"description": "Patch the configuration of a Synthetic test with partial data."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"New test name\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"/config/assertions/0\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"config\": {\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"molli\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"ullamco culpa\",\n \"filename\": \"dolore voluptate eu consectetur\",\n \"updatedAt\": \"ex ut pariatur\"\n },\n \"key\": {\n \"content\": \"magna esse laborum sit labore\",\n \"filename\": \"dolore esse fugiat dolor\",\n \"updatedAt\": \"laborum cupidatat velit\"\n }\n },\n \"checkCertificateRevocation\": true,\n \"compressedJsonDescriptor\": \"consequat\",\n \"compressedProtoFile\": \"in\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"sint\",\n \"dnsServerPort\": -81314582,\n \"files\": [\n {\n \"bucketKey\": \"deserunt culpa\",\n \"content\": \"irure voluptate\",\n \"name\": \"in\",\n \"originalFileName\": \"aute nisi Duis consequat\",\n \"size\": 1746462,\n \"type\": \"sed ad\"\n },\n {\n \"bucketKey\": \"minim magna veniam\",\n \"content\": \"minim ea\",\n \"name\": \"est labore culpa\",\n \"originalFileName\": \"reprehenderit minim\",\n \"size\": 49570,\n \"type\": \"sint in\"\n }\n ],\n \"follow_redirects\": true,\n \"form\": {\n \"commodo_d36\": \"sit\",\n \"aliquad2\": \"irure Ut dolor\"\n },\n \"headers\": {\n \"ipsum_f6\": \"ullamco\",\n \"inb\": \"pariatur reprehenderit volup\",\n \"aliquip_a\": \"nostrud sit\"\n },\n \"host\": \"dolore nisi do\",\n \"httpVersion\": \"http1\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"enim magna\",\n \"metadata\": {\n \"sit_9\": \"sit qui\",\n \"irureb\": \"qui Excepteur quis labore\"\n },\n \"method\": \"deserunt dolor\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 3,\n \"persistCookies\": true,\n \"port\": 13174871,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"ullamco_19\": \"cillum conse\",\n \"non_3\": \"fugiat consequat sunt quis do\"\n }\n },\n \"query\": {},\n \"servername\": \"sint occaecat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": -57415916.183924146,\n \"url\": \"https://example.com\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"creator\": {\n \"email\": \"esse voluptate cillum\",\n \"handle\": \"incididunt ut Excepteur\",\n \"name\": \"labore cupidatat ex ipsum\"\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"message\": \"id\",\n \"monitor_id\": 14287874,\n \"name\": \"ullamco ex dolor nulla\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": false,\n \"disableCors\": false,\n \"disableCsp\": false,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"any\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -28440822,\n \"min_failure_duration\": -69371353,\n \"min_location_failed\": 91791243,\n \"monitor_name\": \"ut\",\n \"monitor_options\": {\n \"escalation_message\": \"in nulla ex dolor\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 85933118,\n \"renotify_occurrences\": 41354040\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 95020496,\n \"interval\": -68705636.8852011\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 22729\n },\n \"public_id\": \"est ut\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": false,\n \"isCritical\": false,\n \"name\": \"ad sed\",\n \"noScreenshot\": true,\n \"params\": {},\n \"public_id\": \"veniam nulla cupidatat\",\n \"timeout\": 57915686,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": true,\n \"exitIfSucceed\": true,\n \"isCritical\": true,\n \"name\": \"sunt\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"nulla ipsum Duis eu Ut\",\n \"timeout\": -20985339,\n \"type\": \"assertElementContent\"\n }\n ],\n \"subtype\": \"http\",\n \"tags\": [\n \"dolor nostrud ea nisi voluptate\",\n \"esse eu\"\n ],\n \"type\": \"browser\"\n}"
},
{
"name": "- JSON format is wrong\n- Updating sub-type is forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"New test name\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"/config/assertions/0\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"New test name\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"/config/assertions/0\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "- Synthetic Monitoring is not activated for the user\n- Test is not owned by the user\n- Test can't be found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"New test name\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"/config/assertions/0\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"op\": \"replace\",\n \"path\": \"/name\",\n \"value\": \"New test name\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"/config/assertions/0\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Pause or start a test",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"new_status\": \"live\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"status"
],
"variable": [
{
"key": "public_id",
"value": "fugiat id"
}
]
},
"description": "Pause or start a Synthetic test by changing the status."
},
"response": [
{
"name": "OK - Returns a boolean indicating if the update was successful.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"new_status\": \"live\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"status"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "true"
},
{
"name": "JSON format is wrong.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"new_status\": \"live\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"status"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"new_status\": \"live\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"status"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "- Synthetic Monitoring is not activated for the user\n- Test is not owned by the user",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"new_status\": \"live\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"status"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"new_status\": \"live\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"status"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Trigger tests from CI/CD pipelines",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"tests\": [\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"allowInsecureCertificates\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"exercitation ad consequat\",\n \"cookies\": \"cupidatat veniam\",\n \"deviceIds\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"followRedirects\": true,\n \"headers\": {\n \"dolore_7\": \"aliqua\",\n \"exercitation16\": \"ut adipisicing sunt consequat dolor\"\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"dolor ad in\"\n },\n \"provider\": {\n \"name\": \"ipsum\"\n }\n },\n \"git\": {\n \"branch\": \"Duis nostrud\",\n \"commitSha\": \"proident ut\"\n }\n },\n \"retry\": {\n \"count\": 58337607,\n \"interval\": 79879859.90322065\n },\n \"startUrl\": \"dolor fugiat eu dolor\",\n \"variables\": {\n \"dolor45\": \"Duis deserunt\"\n },\n \"version\": 70184271\n },\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"allowInsecureCertificates\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"laborum exercitation ut tempor\",\n \"bodyType\": \"esse magna\",\n \"cookies\": \"ut\",\n \"deviceIds\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"followRedirects\": false,\n \"headers\": {\n \"esse1c1\": \"elit exercitation\",\n \"eiusmod17\": \"sunt enim adipisicing labore\"\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"eu elit dolor dolor\"\n },\n \"provider\": {\n \"name\": \"officia labore proident\"\n }\n },\n \"git\": {\n \"branch\": \"esse aliquip veniam aute\",\n \"commitSha\": \"minim consequat magna\"\n }\n },\n \"retry\": {\n \"count\": -70518488,\n \"interval\": 11809116.067818895\n },\n \"startUrl\": \"ea\",\n \"variables\": {\n \"aliqua_4\": \"amet laboris ipsum pariatur\",\n \"voluptate57c\": \"ullamco ex\"\n },\n \"version\": -86686174\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger/ci",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"trigger",
"ci"
]
},
"description": "Trigger a set of Synthetic tests for continuous integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"tests\": [\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"allowInsecureCertificates\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"exercitation ad consequat\",\n \"cookies\": \"cupidatat veniam\",\n \"deviceIds\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"followRedirects\": true,\n \"headers\": {\n \"dolore_7\": \"aliqua\",\n \"exercitation16\": \"ut adipisicing sunt consequat dolor\"\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"dolor ad in\"\n },\n \"provider\": {\n \"name\": \"ipsum\"\n }\n },\n \"git\": {\n \"branch\": \"Duis nostrud\",\n \"commitSha\": \"proident ut\"\n }\n },\n \"retry\": {\n \"count\": 58337607,\n \"interval\": 79879859.90322065\n },\n \"startUrl\": \"dolor fugiat eu dolor\",\n \"variables\": {\n \"dolor45\": \"Duis deserunt\"\n },\n \"version\": 70184271\n },\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"allowInsecureCertificates\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"laborum exercitation ut tempor\",\n \"bodyType\": \"esse magna\",\n \"cookies\": \"ut\",\n \"deviceIds\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"followRedirects\": false,\n \"headers\": {\n \"esse1c1\": \"elit exercitation\",\n \"eiusmod17\": \"sunt enim adipisicing labore\"\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"eu elit dolor dolor\"\n },\n \"provider\": {\n \"name\": \"officia labore proident\"\n }\n },\n \"git\": {\n \"branch\": \"esse aliquip veniam aute\",\n \"commitSha\": \"minim consequat magna\"\n }\n },\n \"retry\": {\n \"count\": -70518488,\n \"interval\": 11809116.067818895\n },\n \"startUrl\": \"ea\",\n \"variables\": {\n \"aliqua_4\": \"amet laboris ipsum pariatur\",\n \"voluptate57c\": \"ullamco ex\"\n },\n \"version\": -86686174\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger/ci",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"trigger",
"ci"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"batch_id\": \"ut non aute laborum\",\n \"locations\": [\n {\n \"id\": 80314642,\n \"name\": \"magna mo\"\n },\n {\n \"id\": -5413245,\n \"name\": \"laboris dolore\"\n }\n ],\n \"results\": [\n {\n \"device\": \"chrome.laptop_large\",\n \"location\": 52058664,\n \"public_id\": \"ad esse\",\n \"result_id\": \"laborum labore exercitation occaecat\"\n },\n {\n \"device\": \"chrome.laptop_large\",\n \"location\": -97251375,\n \"public_id\": \"deserunt nisi do veniam\",\n \"result_id\": \"in nisi\"\n }\n ],\n \"triggered_check_ids\": [\n \"qui consequat sunt\",\n \"in incididunt cupidatat\"\n ]\n}"
},
{
"name": "JSON format is wrong",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"tests\": [\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"allowInsecureCertificates\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"exercitation ad consequat\",\n \"cookies\": \"cupidatat veniam\",\n \"deviceIds\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"followRedirects\": true,\n \"headers\": {\n \"dolore_7\": \"aliqua\",\n \"exercitation16\": \"ut adipisicing sunt consequat dolor\"\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"dolor ad in\"\n },\n \"provider\": {\n \"name\": \"ipsum\"\n }\n },\n \"git\": {\n \"branch\": \"Duis nostrud\",\n \"commitSha\": \"proident ut\"\n }\n },\n \"retry\": {\n \"count\": 58337607,\n \"interval\": 79879859.90322065\n },\n \"startUrl\": \"dolor fugiat eu dolor\",\n \"variables\": {\n \"dolor45\": \"Duis deserunt\"\n },\n \"version\": 70184271\n },\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"allowInsecureCertificates\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"laborum exercitation ut tempor\",\n \"bodyType\": \"esse magna\",\n \"cookies\": \"ut\",\n \"deviceIds\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"followRedirects\": false,\n \"headers\": {\n \"esse1c1\": \"elit exercitation\",\n \"eiusmod17\": \"sunt enim adipisicing labore\"\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"eu elit dolor dolor\"\n },\n \"provider\": {\n \"name\": \"officia labore proident\"\n }\n },\n \"git\": {\n \"branch\": \"esse aliquip veniam aute\",\n \"commitSha\": \"minim consequat magna\"\n }\n },\n \"retry\": {\n \"count\": -70518488,\n \"interval\": 11809116.067818895\n },\n \"startUrl\": \"ea\",\n \"variables\": {\n \"aliqua_4\": \"amet laboris ipsum pariatur\",\n \"voluptate57c\": \"ullamco ex\"\n },\n \"version\": -86686174\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger/ci",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"trigger",
"ci"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"tests\": [\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"allowInsecureCertificates\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"exercitation ad consequat\",\n \"cookies\": \"cupidatat veniam\",\n \"deviceIds\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"followRedirects\": true,\n \"headers\": {\n \"dolore_7\": \"aliqua\",\n \"exercitation16\": \"ut adipisicing sunt consequat dolor\"\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"dolor ad in\"\n },\n \"provider\": {\n \"name\": \"ipsum\"\n }\n },\n \"git\": {\n \"branch\": \"Duis nostrud\",\n \"commitSha\": \"proident ut\"\n }\n },\n \"retry\": {\n \"count\": 58337607,\n \"interval\": 79879859.90322065\n },\n \"startUrl\": \"dolor fugiat eu dolor\",\n \"variables\": {\n \"dolor45\": \"Duis deserunt\"\n },\n \"version\": 70184271\n },\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"allowInsecureCertificates\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"laborum exercitation ut tempor\",\n \"bodyType\": \"esse magna\",\n \"cookies\": \"ut\",\n \"deviceIds\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"followRedirects\": false,\n \"headers\": {\n \"esse1c1\": \"elit exercitation\",\n \"eiusmod17\": \"sunt enim adipisicing labore\"\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"eu elit dolor dolor\"\n },\n \"provider\": {\n \"name\": \"officia labore proident\"\n }\n },\n \"git\": {\n \"branch\": \"esse aliquip veniam aute\",\n \"commitSha\": \"minim consequat magna\"\n }\n },\n \"retry\": {\n \"count\": -70518488,\n \"interval\": 11809116.067818895\n },\n \"startUrl\": \"ea\",\n \"variables\": {\n \"aliqua_4\": \"amet laboris ipsum pariatur\",\n \"voluptate57c\": \"ullamco ex\"\n },\n \"version\": -86686174\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger/ci",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"trigger",
"ci"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Trigger Synthetic tests",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"tests\": [\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"culpa\"\n },\n \"provider\": {\n \"name\": \"magna dolore aliquip irure\"\n }\n },\n \"git\": {\n \"branch\": \"do reprehenderit dolore cupidatat\",\n \"commitSha\": \"cupidatat\"\n }\n }\n },\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"pariatur sint\"\n },\n \"provider\": {\n \"name\": \"dolor\"\n }\n },\n \"git\": {\n \"branch\": \"eiusmod veniam dolore\",\n \"commitSha\": \"minim magna culpa nisi aute\"\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"trigger"
]
},
"description": "Trigger a set of Synthetic tests."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"tests\": [\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"culpa\"\n },\n \"provider\": {\n \"name\": \"magna dolore aliquip irure\"\n }\n },\n \"git\": {\n \"branch\": \"do reprehenderit dolore cupidatat\",\n \"commitSha\": \"cupidatat\"\n }\n }\n },\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"pariatur sint\"\n },\n \"provider\": {\n \"name\": \"dolor\"\n }\n },\n \"git\": {\n \"branch\": \"eiusmod veniam dolore\",\n \"commitSha\": \"minim magna culpa nisi aute\"\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"trigger"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"batch_id\": \"ut non aute laborum\",\n \"locations\": [\n {\n \"id\": 80314642,\n \"name\": \"magna mo\"\n },\n {\n \"id\": -5413245,\n \"name\": \"laboris dolore\"\n }\n ],\n \"results\": [\n {\n \"device\": \"chrome.laptop_large\",\n \"location\": 52058664,\n \"public_id\": \"ad esse\",\n \"result_id\": \"laborum labore exercitation occaecat\"\n },\n {\n \"device\": \"chrome.laptop_large\",\n \"location\": -97251375,\n \"public_id\": \"deserunt nisi do veniam\",\n \"result_id\": \"in nisi\"\n }\n ],\n \"triggered_check_ids\": [\n \"qui consequat sunt\",\n \"in incididunt cupidatat\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"tests\": [\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"culpa\"\n },\n \"provider\": {\n \"name\": \"magna dolore aliquip irure\"\n }\n },\n \"git\": {\n \"branch\": \"do reprehenderit dolore cupidatat\",\n \"commitSha\": \"cupidatat\"\n }\n }\n },\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"pariatur sint\"\n },\n \"provider\": {\n \"name\": \"dolor\"\n }\n },\n \"git\": {\n \"branch\": \"eiusmod veniam dolore\",\n \"commitSha\": \"minim magna culpa nisi aute\"\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"trigger"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"tests\": [\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"culpa\"\n },\n \"provider\": {\n \"name\": \"magna dolore aliquip irure\"\n }\n },\n \"git\": {\n \"branch\": \"do reprehenderit dolore cupidatat\",\n \"commitSha\": \"cupidatat\"\n }\n }\n },\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"pariatur sint\"\n },\n \"provider\": {\n \"name\": \"dolor\"\n }\n },\n \"git\": {\n \"branch\": \"eiusmod veniam dolore\",\n \"commitSha\": \"minim magna culpa nisi aute\"\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"trigger"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a Mobile test",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile",
":public_id"
],
"variable": [
{
"key": "public_id",
"value": "fugiat id"
}
]
},
"description": "Get the detailed configuration associated with\na Synthetic Mobile test."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"config\": {\n \"initialApplicationArguments\": {\n \"proident_aec\": \"\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": \"Example test name\",\n \"options\": {\n \"device_ids\": [\n \"synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16\"\n ],\n \"tick_every\": 300,\n \"mobileApplication\": {\n \"applicationId\": \"00000000-0000-0000-0000-aaaaaaaaaaaa\",\n \"referenceId\": \"00000000-0000-0000-0000-aaaaaaaaaaab\",\n \"referenceType\": \"latest\"\n },\n \"allowApplicationCrash\": true,\n \"bindings\": [\n {\n \"principals\": [\n \"Duis eiusmod deserunt voluptate\",\n \"cillum voluptate adipisicing\"\n ],\n \"relation\": \"editor\"\n },\n {\n \"principals\": [\n \"ex cupidatat eiusmod qui Ut\",\n \"esse ad sint\"\n ],\n \"relation\": \"viewer\"\n }\n ],\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"defaultStepTimeout\": 282,\n \"disableAutoAcceptAlert\": false,\n \"min_failure_duration\": 545,\n \"monitor_name\": \"in aliqua cillum mollit\",\n \"monitor_options\": {\n \"escalation_message\": \"Duis non exercitation reprehenderit cillum\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 81883939,\n \"renotify_occurrences\": 25595889\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -79563905,\n \"interval\": -7235855.908941761\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"verbosity\": 3\n },\n \"type\": \"mobile\",\n \"message\": \"Notification message\",\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"greaterEquals\",\n \"delay\": 2461,\n \"direction\": \"left\",\n \"element\": {\n \"context\": \"velit nulla aliquip\",\n \"contextType\": \"native\",\n \"elementDescription\": \"tempor qui do\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -27475651.19994171,\n \"y\": 37092842.64996117\n },\n \"textContent\": \"irure dolore\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolore\"\n },\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"dolor consectetur dolore id tempor\"\n }\n ]\n },\n \"viewName\": \"ullamco nulla consequat fugiat\"\n },\n \"enabled\": false,\n \"maxScrolls\": 82877890,\n \"positions\": [\n {\n \"x\": -1078933.547199905,\n \"y\": 47306718.14290634\n },\n {\n \"x\": 22066932.774656877,\n \"y\": 5147201.988842264\n }\n ],\n \"subtestPublicId\": \"sit adipisicing anim aliqua\",\n \"value\": \"ex officia quis\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": false,\n \"x\": 62063395.20027858,\n \"y\": -33153663.255412266\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": false,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 2015556\n },\n {\n \"name\": \"\",\n \"params\": {\n \"check\": \"between\",\n \"delay\": 1067,\n \"direction\": \"down\",\n \"element\": {\n \"context\": \"ipsum magna veniam velit\",\n \"contextType\": \"native\",\n \"elementDescription\": \"deserunt incididunt aute\",\n \"multiLocator\": {},\n \"relativePosition\": {\n \"x\": -69073630.84124725,\n \"y\": -12491106.752787441\n },\n \"textContent\": \"ad\",\n \"userLocator\": {\n \"failTestOnCannotLocate\": false,\n \"values\": [\n {\n \"type\": \"ios-predicate-string\",\n \"value\": \"cupidatat consequat dolore\"\n },\n {\n \"type\": \"accessibility-id\",\n \"value\": \"officia in eiusmod dolor\"\n }\n ]\n },\n \"viewName\": \"sunt ut\"\n },\n \"enabled\": true,\n \"maxScrolls\": -60728375,\n \"positions\": [\n {\n \"x\": 46088589.93669158,\n \"y\": -37693278.52496176\n },\n {\n \"x\": 81015891.68192351,\n \"y\": 39635893.741861284\n }\n ],\n \"subtestPublicId\": \"in in\",\n \"value\": \"incididunt culpa\",\n \"variable\": {\n \"description\": \"An example for the variable.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"withEnter\": true,\n \"x\": 75815974.60309061,\n \"y\": 98520978.07872021\n },\n \"type\": \"assertElementContent\",\n \"allowFailure\": true,\n \"hasNewStepElement\": true,\n \"isCritical\": false,\n \"noScreenshot\": true,\n \"publicId\": \"pub-lic-id0\",\n \"timeout\": 54845532\n }\n ],\n \"tags\": [\n \"env:production\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "- Synthetic Monitoring is not activated for the user\n- Test is not owned by the user",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/mobile/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"mobile",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get an API test",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id",
"value": "fugiat id"
}
]
},
"description": "Get the detailed configuration associated with\na Synthetic API test."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"Example test name\",\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"options\": {\n \"accept_self_signed\": false,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": true,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": false,\n \"disableCors\": true,\n \"disableCsp\": false,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -37997999,\n \"min_failure_duration\": 77817896,\n \"min_location_failed\": 38023074,\n \"monitor_name\": \"cupidatat dolore non ut\",\n \"monitor_options\": {\n \"escalation_message\": \"veniam incididunt voluptate\",\n \"notification_preset_name\": \"hide_all\",\n \"renotify_interval\": 33247447,\n \"renotify_occurrences\": -71601604\n },\n \"monitor_priority\": 4,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -63582187,\n \"interval\": 46016019.6128844\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 363049\n },\n \"type\": \"api\",\n \"message\": \"Notification message\",\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "- Synthetic Monitoring is not activated for the user\n- Test is not owned by the user",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a browser test",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id"
],
"variable": [
{
"key": "public_id",
"value": "fugiat id"
}
]
},
"description": "Get the detailed configuration (including steps) associated with\na Synthetic browser test."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"consectetur magna dolor\",\n \"filename\": \"ex\",\n \"updatedAt\": \"Excepteur consequat\"\n },\n \"key\": {\n \"content\": \"voluptate in do ut\",\n \"filename\": \"ut sunt exercitation incididunt aliqua\",\n \"updatedAt\": \"in ex\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"exercitation Ut qui incididunt\",\n \"compressedProtoFile\": \"Excepteur labore quis\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"labore exercitation\",\n \"dnsServerPort\": -69565807,\n \"files\": [\n {\n \"bucketKey\": \"fugiat magna proident\",\n \"content\": \"laborum sit incididunt officia proident\",\n \"name\": \"dolore Duis in esse\",\n \"originalFileName\": \"sint culpa nulla ea\",\n \"size\": 445243,\n \"type\": \"proident eu occaecat laborum ea\"\n },\n {\n \"bucketKey\": \"irure laborum ipsum cupidatat\",\n \"content\": \"esse eu deserunt ut\",\n \"name\": \"consequat et\",\n \"originalFileName\": \"magna eu id consequat\",\n \"size\": 1566384,\n \"type\": \"dolore sint nulla dolor\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"cupidatat4\": \"ullamco esse adipisicing\"\n },\n \"headers\": {\n \"in_c\": \"ut est enim Lorem id\",\n \"labore_b\": \"ipsum dolor dolore\"\n },\n \"host\": \"magna aute\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"consequat veniam\",\n \"metadata\": {\n \"Lorem2\": \"ea ullamco occaecat eiusmod\"\n },\n \"method\": \"cupi\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 9,\n \"persistCookies\": true,\n \"port\": -17384036,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eu_7a3\": \"Ut\",\n \"sintbbf\": \"pariatur non consectetur dolor\",\n \"enim__\": \"offic\"\n }\n },\n \"query\": {},\n \"servername\": \"nostrud consequat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": 89752470.07114398,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"i\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": true,\n \"initialNavigationTimeout\": 11733301,\n \"min_failure_duration\": -87057457,\n \"min_location_failed\": -52413111,\n \"monitor_name\": \"elit do reprehenderit laborum\",\n \"monitor_options\": {\n \"escalation_message\": \"anim commodo minim reprehenderit velit\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60519217,\n \"renotify_occurrences\": 227529\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 24009461,\n \"interval\": 97196217.90698808\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 413863\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -97266407,\n \"public_id\": \"in eu\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"deserunt et proident\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"in nisi fugiat\",\n \"timeout\": 90794253,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"voluptate incididunt aliqua sit\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"eiusmod proident enim Duis fugiat\",\n \"timeout\": -46669948,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "- Synthetic Monitoring is not activated for the user\n- Test is not owned by the user",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get the on-demand concurrency cap",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/synthetics/settings/on_demand_concurrency_cap",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"synthetics",
"settings",
"on_demand_concurrency_cap"
]
},
"description": "Get the on-demand concurrency cap."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/synthetics/settings/on_demand_concurrency_cap",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"synthetics",
"settings",
"on_demand_concurrency_cap"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"on_demand_concurrency_cap\": -69812288.0187787\n },\n \"type\": \"on_demand_concurrency_cap\"\n }\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/synthetics/settings/on_demand_concurrency_cap",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"synthetics",
"settings",
"on_demand_concurrency_cap"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get the list of all Synthetic tests",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests?page_size=100&page_number=92403352",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests"
],
"query": [
{
"key": "page_size",
"value": "100",
"description": "Used for pagination. The number of tests returned in the page."
},
{
"key": "page_number",
"value": "92403352",
"description": "Used for pagination. Which page you want to retrieve. Starts at zero."
}
]
},
"description": "Get the list of all Synthetic tests."
},
"response": [
{
"name": "OK - Returns the list of all Synthetic tests.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests?page_size=100&page_number=92403352",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests"
],
"query": [
{
"key": "page_size",
"value": "100",
"description": "Used for pagination. The number of tests returned in the page."
},
{
"key": "page_number",
"value": "92403352",
"description": "Used for pagination. Which page you want to retrieve. Starts at zero."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"tests\": [\n {\n \"config\": {\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"volu\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"amet sunt\",\n \"filename\": \"veniam dolor irure\",\n \"updatedAt\": \"culpa reprehenderit elit ipsum commodo\"\n },\n \"key\": {\n \"content\": \"Excepteur\",\n \"filename\": \"ut dolor Duis laboris\",\n \"updatedAt\": \"ad et Lorem esse\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"quis esse aute mollit ad\",\n \"compressedProtoFile\": \"irure Excepteur nulla ex do\",\n \"disableAiaIntermediateFetching\": false,\n \"dnsServer\": \"ex tempor aliquip anim\",\n \"dnsServerPort\": -59421584,\n \"files\": [\n {\n \"bucketKey\": \"adipisicing dolo\",\n \"content\": \"ex velit nulla ut\",\n \"name\": \"Ut adipisicing\",\n \"originalFileName\": \"nostrud dolor Excepteur\",\n \"size\": 2825770,\n \"type\": \"non\"\n },\n {\n \"bucketKey\": \"sunt fugiat\",\n \"content\": \"do\",\n \"name\": \"officia eu labore\",\n \"originalFileName\": \"velit cupidatat\",\n \"size\": 341624,\n \"type\": \"occaecat pariatur\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"reprehenderit_a16\": \"ad anim et tempor\",\n \"minim28_\": \"id dolor\",\n \"non_74\": \"labore dolor\"\n },\n \"headers\": {\n \"inc26\": \"velit esse cillum\"\n },\n \"host\": \"do\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": false,\n \"message\": \"cillum laborum\",\n \"metadata\": {\n \"adipisicing_2d_\": \"ut reprehenderit dol\"\n },\n \"method\": \"adipisicing\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 3,\n \"persistCookies\": false,\n \"port\": -35694923,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"in7e_\": \"commod\",\n \"Ut_c\": \"adipisicing est eu in\"\n }\n },\n \"query\": {},\n \"servername\": \"do eiusmod sit\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": false,\n \"timeout\": -57526929.16111501,\n \"url\": \"https://example.com\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"creator\": {\n \"email\": \"nulla culpa in aliqua\",\n \"handle\": \"magna laboris in\",\n \"name\": \"pariatur quis reprehenderit dolore\"\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"message\": \"amet exercitation voluptate aute\",\n \"monitor_id\": -15149534,\n \"name\": \"exercitation adipisicing nulla\",\n \"options\": {\n \"accept_self_signed\": false,\n \"allow_insecure\": false,\n \"checkCertificateRevocation\": true,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": false,\n \"enableProfiling\": true,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -17449253,\n \"min_failure_duration\": 31639462,\n \"min_location_failed\": -35550965,\n \"monitor_name\": \"ad aute in anim\",\n \"monitor_options\": {\n \"escalation_message\": \"non qui amet\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 2271687,\n \"renotify_occurrences\": 32041056\n },\n \"monitor_priority\": 2,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 21051534,\n \"interval\": 29949687.874488756\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 205898\n },\n \"public_id\": \"Ut id veniam Lorem laboris\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": false,\n \"isCritical\": false,\n \"name\": \"deserunt aute officia laboris\",\n \"noScreenshot\": true,\n \"params\": {},\n \"public_id\": \"velit exercitation id\",\n \"timeout\": -3498123,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"ullamco dolor cupidatat\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"aliquip quis consequat labore\",\n \"timeout\": -2513125,\n \"type\": \"assertElementContent\"\n }\n ],\n \"subtype\": \"http\",\n \"tags\": [\n \"exercitation\",\n \"adipisicing eu occaecat\"\n ],\n \"type\": \"browser\"\n },\n {\n \"config\": {\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"request\": {\n \"allow_insecure\": true,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor Excepteur in\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"esse reprehende\",\n \"filename\": \"veniam sunt\",\n \"updatedAt\": \"ut pariatur sed\"\n },\n \"key\": {\n \"content\": \"aute\",\n \"filename\": \"sit adipi\",\n \"updatedAt\": \"c\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"in velit laboris et\",\n \"compressedProtoFile\": \"of\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"\",\n \"dnsServerPort\": -32899771,\n \"files\": [\n {\n \"bucketKey\": \"culpa Excepteur\",\n \"content\": \"voluptate et\",\n \"name\": \"velit pariatur do\",\n \"originalFileName\": \"in culpa sunt magna\",\n \"size\": 670743,\n \"type\": \"non incididunt eu magna adipisicing\"\n },\n {\n \"bucketKey\": \"laboris sit elit incididunt\",\n \"content\": \"ea exercitation ipsum quis do\",\n \"name\": \"dolor qui incididunt non deserunt\",\n \"originalFileName\": \"incididunt\",\n \"size\": 829263,\n \"type\": \"incididunt sed ut velit Lorem\"\n }\n ],\n \"follow_redirects\": true,\n \"form\": {\n \"este6\": \"veniam magna\"\n },\n \"headers\": {\n \"nisi_c\": \"Duis veniam occaecat nisi\"\n },\n \"host\": \"et sit id ullamco\",\n \"httpVersion\": \"http2\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"laborum enim\",\n \"metadata\": {\n \"dolore_9d\": \"et laborum exercitation\"\n },\n \"method\": \"dolore\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 4,\n \"persistCookies\": true,\n \"port\": -38198684,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eiusmod67\": \"anim esse\",\n \"ametd\": \"qui dolore irure\"\n }\n },\n \"query\": {},\n \"servername\": \"nulla exercitation mollit\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": -21710062.677636683,\n \"url\": \"https://example.com\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"creator\": {\n \"email\": \"tempor ullamco\",\n \"handle\": \"consectetur aliqua esse cupidatat deserunt\",\n \"name\": \"cillum non velit\"\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"message\": \"magna id officia occaecat\",\n \"monitor_id\": 15547925,\n \"name\": \"eiu\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": false,\n \"checkCertificateRevocation\": true,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": false,\n \"disableCors\": false,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": true,\n \"httpVersion\": \"http1\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -20850138,\n \"min_failure_duration\": 30560548,\n \"min_location_failed\": 46914207,\n \"monitor_name\": \"ad c\",\n \"monitor_options\": {\n \"escalation_message\": \"anim\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 42330487,\n \"renotify_occurrences\": -55228052\n },\n \"monitor_priority\": 3,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -813125,\n \"interval\": 32336444.830152363\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 407132\n },\n \"public_id\": \"dolor ut\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": true,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": false,\n \"isCritical\": false,\n \"name\": \"culpa et\",\n \"noScreenshot\": true,\n \"params\": {},\n \"public_id\": \"ipsum sit adipisicing\",\n \"timeout\": 96621516,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"nulla sunt exercitation Excepteur\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"ut\",\n \"timeout\": 41171798,\n \"type\": \"assertElementContent\"\n }\n ],\n \"subtype\": \"http\",\n \"tags\": [\n \"ullamco nisi nostrud\",\n \"adipisicing laborum\"\n ],\n \"type\": \"browser\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests?page_size=100&page_number=92403352",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests"
],
"query": [
{
"key": "page_size",
"value": "100",
"description": "Used for pagination. The number of tests returned in the page."
},
{
"key": "page_number",
"value": "92403352",
"description": "Used for pagination. Which page you want to retrieve. Starts at zero."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Synthetic Monitoring is not activated for the user.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests?page_size=100&page_number=92403352",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests"
],
"query": [
{
"key": "page_size",
"value": "100",
"description": "Used for pagination. The number of tests returned in the page."
},
{
"key": "page_number",
"value": "92403352",
"description": "Used for pagination. Which page you want to retrieve. Starts at zero."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests?page_size=100&page_number=92403352",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests"
],
"query": [
{
"key": "page_size",
"value": "100",
"description": "Used for pagination. The number of tests returned in the page."
},
{
"key": "page_number",
"value": "92403352",
"description": "Used for pagination. Which page you want to retrieve. Starts at zero."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Save new value for on-demand concurrency cap",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"on_demand_concurrency_cap\": -3114080.3363865167\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/synthetics/settings/on_demand_concurrency_cap",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"synthetics",
"settings",
"on_demand_concurrency_cap"
]
},
"description": "Save new value for on-demand concurrency cap."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"on_demand_concurrency_cap\": -3114080.3363865167\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/synthetics/settings/on_demand_concurrency_cap",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"synthetics",
"settings",
"on_demand_concurrency_cap"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"on_demand_concurrency_cap\": -69812288.0187787\n },\n \"type\": \"on_demand_concurrency_cap\"\n }\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"on_demand_concurrency_cap\": -3114080.3363865167\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/synthetics/settings/on_demand_concurrency_cap",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"synthetics",
"settings",
"on_demand_concurrency_cap"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get an API test result",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/results/:result_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"results",
":result_id"
],
"variable": [
{
"key": "public_id",
"value": "fugiat id"
},
{
"key": "result_id",
"value": "fugiat id"
}
]
},
"description": "Get a specific full result from a given Synthetic API test."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/results/:result_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"results",
":result_id"
],
"variable": [
{
"key": "public_id"
},
{
"key": "result_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"check\": {\n \"config\": {\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"request\": {\n \"allow_insecure\": true,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"qui\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"cupidatat incididunt Ut minim\",\n \"filename\": \"esse id non Excepteur reprehenderit\",\n \"updatedAt\": \"reprehenderit in\"\n },\n \"key\": {\n \"content\": \"sint nulla ex\",\n \"filename\": \"in in veniam\",\n \"updatedAt\": \"sint id magna\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"consectetur in in laborum\",\n \"compressedProtoFile\": \"esse culpa\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"eiusmod\",\n \"dnsServerPort\": 39952572,\n \"files\": [\n {\n \"bucketKey\": \"d\",\n \"content\": \"commodo consequat magna aliqua ullamco\",\n \"name\": \"ad ut aliquip labore\",\n \"originalFileName\": \"quis ipsum sunt et\",\n \"size\": 2338425,\n \"type\": \"exercitation deserunt do\"\n },\n {\n \"bucketKey\": \"no\",\n \"content\": \"pariatur amet\",\n \"name\": \"magna\",\n \"originalFileName\": \"reprehender\",\n \"size\": 670768,\n \"type\": \"quis dolore\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"id48\": \"ea sed dolor aute\"\n },\n \"headers\": {\n \"officia_9d\": \"aliqua nisi ut est\",\n \"dolore1bc\": \"labore eu la\"\n },\n \"host\": \"labore\",\n \"httpVersion\": \"http1\",\n \"isMessageBase64Encoded\": false,\n \"message\": \"s\",\n \"metadata\": {\n \"mollitb\": \"eu et sint dolore\"\n },\n \"method\": \"aute dolore\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 1,\n \"persistCookies\": false,\n \"port\": 70835696,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"ut301\": \"sit incididunt sint deserunt in\"\n }\n },\n \"query\": {},\n \"servername\": \"esse\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": -50186628.26502942,\n \"url\": \"https://example.com\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"check_time\": 12289382.359225765,\n \"check_version\": -86203467,\n \"probe_dc\": \"cupidatat labore nulla sed consequat\",\n \"result\": {\n \"cert\": {\n \"cipher\": \"nostrud id dolore proident\",\n \"exponent\": 75556870.27786091,\n \"extKeyUsage\": [\n \"elit dolore dolore\",\n \"nisi sit Lorem tempor veniam\"\n ],\n \"fingerprint\": \"laborum\",\n \"fingerprint256\": \"laborum Duis sit i\",\n \"issuer\": {\n \"C\": \"voluptate\",\n \"CN\": \"ex deserunt elit\",\n \"L\": \"dolor voluptate ea dolor enim\",\n \"O\": \"in proident consectetur Lorem\",\n \"OU\": \"deserunt laborum ut\",\n \"ST\": \"culpa cillum velit\"\n },\n \"modulus\": \"nulla aliquip incididunt\",\n \"protocol\": \"consequat aliqua Lorem\",\n \"serialNumber\": \"cillum irure\",\n \"subject\": {\n \"C\": \"occ\",\n \"CN\": \"nostrud dolore\",\n \"L\": \"ex\",\n \"O\": \"nisi dolore consectetur sed\",\n \"OU\": \"laborum exercitation\",\n \"ST\": \"cillum qui proident\",\n \"altName\": \"et aliquip\"\n },\n \"validFrom\": \"1974-06-08T20:42:38.437Z\",\n \"validTo\": \"1951-11-10T21:11:13.551Z\"\n },\n \"eventType\": \"finished_with_error\",\n \"failure\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"Error during DNS resolution (ENOTFOUND).\"\n },\n \"httpStatusCode\": 3690579,\n \"requestHeaders\": {\n \"magna5\": {},\n \"ex_5\": {}\n },\n \"responseBody\": \"adipisicing aliquip consectetur quis\",\n \"responseHeaders\": {\n \"quis_b5\": {\n \"description\": \"Returned request header.\"\n }\n },\n \"responseSize\": 79644639,\n \"timings\": {\n \"dns\": -96552724.92172253,\n \"download\": 93222417.75440168,\n \"firstByte\": 19218439.018363237,\n \"handshake\": 26245489.447463363,\n \"redirect\": -52059298.6547733,\n \"ssl\": 41042003.6920096,\n \"tcp\": 63355499.661771655,\n \"total\": 96878091.49621427,\n \"wait\": 9830600.26731874\n }\n },\n \"result_id\": \"aute dolor laboris\",\n \"status\": 1\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/results/:result_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"results",
":result_id"
],
"variable": [
{
"key": "public_id"
},
{
"key": "result_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "- Synthetic Monitoring is not activated for the user\n- Test or result is not owned by the user",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/results/:result_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"results",
":result_id"
],
"variable": [
{
"key": "public_id"
},
{
"key": "result_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/results/:result_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"results",
":result_id"
],
"variable": [
{
"key": "public_id"
},
{
"key": "result_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a browser test result",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id/results/:result_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id",
"results",
":result_id"
],
"variable": [
{
"key": "public_id",
"value": "fugiat id"
},
{
"key": "result_id",
"value": "fugiat id"
}
]
},
"description": "Get a specific full result from a given Synthetic browser test."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id/results/:result_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id",
"results",
":result_id"
],
"variable": [
{
"key": "public_id"
},
{
"key": "result_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "null"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id/results/:result_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id",
"results",
":result_id"
],
"variable": [
{
"key": "public_id"
},
{
"key": "result_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "- Synthetic Monitoring is not activated for the user\n- Test or result is not owned by the user",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id/results/:result_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id",
"results",
":result_id"
],
"variable": [
{
"key": "public_id"
},
{
"key": "result_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id/results/:result_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id",
"results",
":result_id"
],
"variable": [
{
"key": "public_id"
},
{
"key": "result_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get an API test's latest results summaries",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/results?from_ts=92403352&to_ts=92403352&probe_dc=cupidatat sit irure&probe_dc=Ut qui Excepteur",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"results"
],
"query": [
{
"key": "from_ts",
"value": "92403352",
"description": "Timestamp in milliseconds from which to start querying results."
},
{
"key": "to_ts",
"value": "92403352",
"description": "Timestamp in milliseconds up to which to query results."
},
{
"key": "probe_dc",
"value": "cupidatat sit irure",
"description": "Locations for which to query results."
},
{
"key": "probe_dc",
"value": "Ut qui Excepteur",
"description": "Locations for which to query results."
}
],
"variable": [
{
"key": "public_id",
"value": "fugiat id"
}
]
},
"description": "Get the last 150 test results summaries for a given Synthetic API test."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/results?from_ts=92403352&to_ts=92403352&probe_dc=Ut qui Excepteur",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"results"
],
"query": [
{
"key": "from_ts",
"value": "92403352",
"description": "Timestamp in milliseconds from which to start querying results."
},
{
"key": "to_ts",
"value": "92403352",
"description": "Timestamp in milliseconds up to which to query results."
},
{
"key": "probe_dc",
"value": "Ut qui Excepteur",
"description": "Locations for which to query results."
}
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"last_timestamp_fetched\": 68357602,\n \"results\": [\n {\n \"check_time\": -79909385.1106089,\n \"probe_dc\": \"ullamco sit\",\n \"result\": {\n \"passed\": false,\n \"timings\": {\n \"dns\": -68920450.14973989,\n \"download\": 17765119.938201115,\n \"firstByte\": -34739321.79569135,\n \"handshake\": 79446346.64944118,\n \"redirect\": 13438035.656813473,\n \"ssl\": 94662846.46531528,\n \"tcp\": -96953582.6412799,\n \"total\": 3783611.0879793167,\n \"wait\": -74245115.88535811\n }\n },\n \"result_id\": \"eiusmod id minim sed reprehenderit\",\n \"status\": 2\n },\n {\n \"check_time\": 83315575.62496549,\n \"probe_dc\": \"aliqua et consectetur Duis ullamco\",\n \"result\": {\n \"passed\": true,\n \"timings\": {\n \"dns\": -27149168.133959934,\n \"download\": -87962292.67780378,\n \"firstByte\": 72265232.36887649,\n \"handshake\": -24684480.789878815,\n \"redirect\": 46976432.294724554,\n \"ssl\": -81708880.25030449,\n \"tcp\": -76661195.17351463,\n \"total\": 51532564.882535756,\n \"wait\": 99607360.1080941\n }\n },\n \"result_id\": \"dolore tempor ip\",\n \"status\": 2\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/results?from_ts=92403352&to_ts=92403352&probe_dc=Ut qui Excepteur",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"results"
],
"query": [
{
"key": "from_ts",
"value": "92403352",
"description": "Timestamp in milliseconds from which to start querying results."
},
{
"key": "to_ts",
"value": "92403352",
"description": "Timestamp in milliseconds up to which to query results."
},
{
"key": "probe_dc",
"value": "Ut qui Excepteur",
"description": "Locations for which to query results."
}
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "- Synthetic is not activated for the user\n- Test is not owned by the user",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/results?from_ts=92403352&to_ts=92403352&probe_dc=Ut qui Excepteur",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"results"
],
"query": [
{
"key": "from_ts",
"value": "92403352",
"description": "Timestamp in milliseconds from which to start querying results."
},
{
"key": "to_ts",
"value": "92403352",
"description": "Timestamp in milliseconds up to which to query results."
},
{
"key": "probe_dc",
"value": "Ut qui Excepteur",
"description": "Locations for which to query results."
}
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/results?from_ts=92403352&to_ts=92403352&probe_dc=Ut qui Excepteur",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id",
"results"
],
"query": [
{
"key": "from_ts",
"value": "92403352",
"description": "Timestamp in milliseconds from which to start querying results."
},
{
"key": "to_ts",
"value": "92403352",
"description": "Timestamp in milliseconds up to which to query results."
},
{
"key": "probe_dc",
"value": "Ut qui Excepteur",
"description": "Locations for which to query results."
}
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a browser test's latest results summaries",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id/results?from_ts=92403352&to_ts=92403352&probe_dc=cupidatat sit irure&probe_dc=Ut qui Excepteur",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id",
"results"
],
"query": [
{
"key": "from_ts",
"value": "92403352",
"description": "Timestamp in milliseconds from which to start querying results."
},
{
"key": "to_ts",
"value": "92403352",
"description": "Timestamp in milliseconds up to which to query results."
},
{
"key": "probe_dc",
"value": "cupidatat sit irure",
"description": "Locations for which to query results."
},
{
"key": "probe_dc",
"value": "Ut qui Excepteur",
"description": "Locations for which to query results."
}
],
"variable": [
{
"key": "public_id",
"value": "fugiat id"
}
]
},
"description": "Get the last 150 test results summaries for a given Synthetic browser test."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id/results?from_ts=92403352&to_ts=92403352&probe_dc=Ut qui Excepteur",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id",
"results"
],
"query": [
{
"key": "from_ts",
"value": "92403352",
"description": "Timestamp in milliseconds from which to start querying results."
},
{
"key": "to_ts",
"value": "92403352",
"description": "Timestamp in milliseconds up to which to query results."
},
{
"key": "probe_dc",
"value": "Ut qui Excepteur",
"description": "Locations for which to query results."
}
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"last_timestamp_fetched\": 36323075,\n \"results\": [\n {\n \"check_time\": -62430579.485938,\n \"probe_dc\": \"eiusmod\",\n \"result\": {\n \"device\": {\n \"id\": \"chrome.laptop_large\",\n \"name\": \"\",\n \"height\": 0,\n \"width\": 0,\n \"isMobile\": false\n },\n \"duration\": 5421396.176284105,\n \"errorCount\": 19964484,\n \"stepCountCompleted\": 66975370,\n \"stepCountTotal\": -30418591\n },\n \"result_id\": \"comm\",\n \"status\": 0\n },\n {\n \"check_time\": -57605775.806723595,\n \"probe_dc\": \"nulla velit in\",\n \"result\": {\n \"device\": {\n \"id\": \"chrome.laptop_large\",\n \"name\": \"\",\n \"height\": 0,\n \"width\": 0,\n \"isMobile\": true\n },\n \"duration\": 52224162.97399813,\n \"errorCount\": -86838384,\n \"stepCountCompleted\": -21963152,\n \"stepCountTotal\": -99049940\n },\n \"result_id\": \"laboris laborum adipisicing exercitation\",\n \"status\": 2\n }\n ]\n}"
},
{
"name": "forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id/results?from_ts=92403352&to_ts=92403352&probe_dc=Ut qui Excepteur",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id",
"results"
],
"query": [
{
"key": "from_ts",
"value": "92403352",
"description": "Timestamp in milliseconds from which to start querying results."
},
{
"key": "to_ts",
"value": "92403352",
"description": "Timestamp in milliseconds up to which to query results."
},
{
"key": "probe_dc",
"value": "Ut qui Excepteur",
"description": "Locations for which to query results."
}
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "- Synthetic Monitoring is not activated for the user\n- Test is not owned by the user",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id/results?from_ts=92403352&to_ts=92403352&probe_dc=Ut qui Excepteur",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id",
"results"
],
"query": [
{
"key": "from_ts",
"value": "92403352",
"description": "Timestamp in milliseconds from which to start querying results."
},
{
"key": "to_ts",
"value": "92403352",
"description": "Timestamp in milliseconds up to which to query results."
},
{
"key": "probe_dc",
"value": "Ut qui Excepteur",
"description": "Locations for which to query results."
}
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id/results?from_ts=92403352&to_ts=92403352&probe_dc=Ut qui Excepteur",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id",
"results"
],
"query": [
{
"key": "from_ts",
"value": "92403352",
"description": "Timestamp in milliseconds from which to start querying results."
},
{
"key": "to_ts",
"value": "92403352",
"description": "Timestamp in milliseconds up to which to query results."
},
{
"key": "probe_dc",
"value": "Ut qui Excepteur",
"description": "Locations for which to query results."
}
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get details of batch",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/ci/batch/:batch_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"ci",
"batch",
":batch_id"
],
"variable": [
{
"key": "batch_id",
"value": "fugiat id"
}
]
},
"description": "Get a batch's updated details."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/ci/batch/:batch_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"ci",
"batch",
":batch_id"
],
"variable": [
{
"key": "batch_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"ut eiusmod nulla elit\"\n },\n \"provider\": {\n \"name\": \"in commodo\"\n }\n },\n \"git\": {\n \"branch\": \"irure est adipisicing labore\",\n \"commitSha\": \"Ut ullamco tempor\"\n }\n },\n \"results\": [\n {\n \"device\": \"chrome.laptop_large\",\n \"duration\": -9023572.482136369,\n \"execution_rule\": \"blocking\",\n \"location\": \"est dolor reprehenderit\",\n \"result_id\": \"consectetur nisi in elit aliquip\",\n \"retries\": 74592552.3587414,\n \"status\": \"skipped\",\n \"test_name\": \"ut\",\n \"test_public_id\": \"ullamco\",\n \"test_type\": \"browser\"\n },\n {\n \"device\": \"chrome.laptop_large\",\n \"duration\": 87199099.79240704,\n \"execution_rule\": \"blocking\",\n \"location\": \"in occaecat\",\n \"result_id\": \"Lorem reprehenderit id velit\",\n \"retries\": 56798460.5541254,\n \"status\": \"passed\",\n \"test_name\": \"in Duis\",\n \"test_public_id\": \"sint qui aute Excepteur\",\n \"test_type\": \"mobile\"\n }\n ],\n \"status\": \"failed\"\n }\n}"
},
{
"name": "Batch does not exist.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/ci/batch/:batch_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"ci",
"batch",
":batch_id"
],
"variable": [
{
"key": "batch_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/ci/batch/:batch_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"ci",
"batch",
":batch_id"
],
"variable": [
{
"key": "batch_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete tests",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"force_delete_dependencies\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"delete"
]
},
"description": "Delete multiple Synthetic tests by ID."
},
"response": [
{
"name": "OK.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"force_delete_dependencies\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"delete"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"deleted_tests\": [\n {\n \"deleted_at\": \"1991-01-01T16:48:41.736Z\",\n \"public_id\": \"Lorem elit\"\n },\n {\n \"deleted_at\": \"1950-09-20T14:26:44.270Z\",\n \"public_id\": \"elit\"\n }\n ]\n}"
},
{
"name": "- JSON format is wrong\n- Test cannot be deleted as it's used elsewhere (as a sub-test or in an uptime widget)\n- Some IDs are not owned by the user",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"force_delete_dependencies\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"delete"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"force_delete_dependencies\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"delete"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "- Tests to be deleted can't be found\n- Synthetic is not activated for the user",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"force_delete_dependencies\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"delete"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"force_delete_dependencies\": false\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"delete"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all global variables",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
},
"description": "Get the list of all Synthetic global variables."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"variables\": [\n {\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n },\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"mollit dolor ad\",\n \"is_fido\": true,\n \"is_totp\": false,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\"\n },\n {\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n },\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"ut tempor\",\n \"is_fido\": true,\n \"is_totp\": true,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a global variable",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"aliquip culpa\",\n \"is_fido\": false,\n \"is_totp\": true,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\",\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
},
"description": "Create a Synthetic global variable."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"aliquip culpa\",\n \"is_fido\": false,\n \"is_totp\": true,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\",\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n },\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"adipisicing commodo\",\n \"is_fido\": false,\n \"is_totp\": true,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\"\n}"
},
{
"name": "Invalid request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"aliquip culpa\",\n \"is_fido\": false,\n \"is_totp\": true,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\",\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"aliquip culpa\",\n \"is_fido\": false,\n \"is_totp\": true,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\",\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"aliquip culpa\",\n \"is_fido\": false,\n \"is_totp\": true,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\",\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"aliquip culpa\",\n \"is_fido\": false,\n \"is_totp\": true,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\",\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a global variable",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id",
"value": "fugiat id"
}
]
},
"description": "Get the detailed configuration of a global variable."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n },\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"adipisicing commodo\",\n \"is_fido\": false,\n \"is_totp\": true,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\"\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Edit a global variable",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"aliquip culpa\",\n \"is_fido\": false,\n \"is_totp\": true,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\",\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id",
"value": "fugiat id"
}
]
},
"description": "Edit a Synthetic global variable."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"aliquip culpa\",\n \"is_fido\": false,\n \"is_totp\": true,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\",\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n },\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"adipisicing commodo\",\n \"is_fido\": false,\n \"is_totp\": true,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\"\n}"
},
{
"name": "Invalid request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"aliquip culpa\",\n \"is_fido\": false,\n \"is_totp\": true,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\",\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"aliquip culpa\",\n \"is_fido\": false,\n \"is_totp\": true,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\",\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"aliquip culpa\",\n \"is_fido\": false,\n \"is_totp\": true,\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\",\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a global variable",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id",
"value": "fugiat id"
}
]
},
"description": "Delete a Synthetic global variable."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "JSON format is wrong",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a private location",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"nulla pariatur ut mollit\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"sit consequat\",\n \"key\": \"in enim minim labor\"\n },\n \"config_decryption\": {\n \"key\": \"labore aute\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations"
]
},
"description": "Create a new Synthetic private location."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"nulla pariatur ut mollit\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"sit consequat\",\n \"key\": \"in enim minim labor\"\n },\n \"config_decryption\": {\n \"key\": \"labore aute\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"config\": {},\n \"private_location\": {\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"anim in dolor\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"laborum proident est\",\n \"key\": \"eu sed esse\"\n },\n \"config_decryption\": {\n \"key\": \"amet aliqua laborum\"\n }\n }\n },\n \"result_encryption\": {\n \"id\": \"aliquip sunt\",\n \"key\": \"ea consectetu\"\n }\n}"
},
{
"name": "Quota reached for private locations",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"nulla pariatur ut mollit\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"sit consequat\",\n \"key\": \"in enim minim labor\"\n },\n \"config_decryption\": {\n \"key\": \"labore aute\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations"
]
}
},
"status": "Payment Required",
"code": 402,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Private locations are not activated for the user",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"nulla pariatur ut mollit\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"sit consequat\",\n \"key\": \"in enim minim labor\"\n },\n \"config_decryption\": {\n \"key\": \"labore aute\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"nulla pariatur ut mollit\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"sit consequat\",\n \"key\": \"in enim minim labor\"\n },\n \"config_decryption\": {\n \"key\": \"labore aute\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a private location",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id",
"value": "fugiat id"
}
]
},
"description": "Get a Synthetic private location."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"nulla pariatur ut mollit\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"sit consequat\",\n \"key\": \"in enim minim labor\"\n },\n \"config_decryption\": {\n \"key\": \"labore aute\"\n }\n }\n}"
},
{
"name": "- Synthetic private locations are not activated for the user\n- Private location does not exist",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Edit a private location",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"nulla pariatur ut mollit\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"sit consequat\",\n \"key\": \"in enim minim labor\"\n },\n \"config_decryption\": {\n \"key\": \"labore aute\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id",
"value": "fugiat id"
}
]
},
"description": "Edit a Synthetic private location."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"nulla pariatur ut mollit\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"sit consequat\",\n \"key\": \"in enim minim labor\"\n },\n \"config_decryption\": {\n \"key\": \"labore aute\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"nulla pariatur ut mollit\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"sit consequat\",\n \"key\": \"in enim minim labor\"\n },\n \"config_decryption\": {\n \"key\": \"labore aute\"\n }\n }\n}"
},
{
"name": "- Private locations are not activated for the user\n- Private location does not exist",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"nulla pariatur ut mollit\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"sit consequat\",\n \"key\": \"in enim minim labor\"\n },\n \"config_decryption\": {\n \"key\": \"labore aute\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"nulla pariatur ut mollit\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"sit consequat\",\n \"key\": \"in enim minim labor\"\n },\n \"config_decryption\": {\n \"key\": \"labore aute\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all locations (public and private)",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"locations"
]
},
"description": "Get the list of public and private locations available for Synthetic\ntests. No arguments required."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"locations"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"locations\": [\n {\n \"id\": \"consequat amet est et\",\n \"name\": \"eiusmod occaecat\"\n },\n {\n \"id\": \"ipsum consequat aliquip ut ullamc\",\n \"name\": \"aute magna ipsum ad occaecat\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"locations"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a private location",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id",
"value": "fugiat id"
}
]
},
"description": "Delete a Synthetic private location."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "- Private locations are not activated for the user\n- Private location does not exist",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a test configuration",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id"
],
"variable": [
{
"key": "public_id",
"value": "fugiat id"
}
]
},
"description": "Get the detailed configuration associated with a Synthetic test."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"config\": {\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"molli\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"ullamco culpa\",\n \"filename\": \"dolore voluptate eu consectetur\",\n \"updatedAt\": \"ex ut pariatur\"\n },\n \"key\": {\n \"content\": \"magna esse laborum sit labore\",\n \"filename\": \"dolore esse fugiat dolor\",\n \"updatedAt\": \"laborum cupidatat velit\"\n }\n },\n \"checkCertificateRevocation\": true,\n \"compressedJsonDescriptor\": \"consequat\",\n \"compressedProtoFile\": \"in\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"sint\",\n \"dnsServerPort\": -81314582,\n \"files\": [\n {\n \"bucketKey\": \"deserunt culpa\",\n \"content\": \"irure voluptate\",\n \"name\": \"in\",\n \"originalFileName\": \"aute nisi Duis consequat\",\n \"size\": 1746462,\n \"type\": \"sed ad\"\n },\n {\n \"bucketKey\": \"minim magna veniam\",\n \"content\": \"minim ea\",\n \"name\": \"est labore culpa\",\n \"originalFileName\": \"reprehenderit minim\",\n \"size\": 49570,\n \"type\": \"sint in\"\n }\n ],\n \"follow_redirects\": true,\n \"form\": {\n \"commodo_d36\": \"sit\",\n \"aliquad2\": \"irure Ut dolor\"\n },\n \"headers\": {\n \"ipsum_f6\": \"ullamco\",\n \"inb\": \"pariatur reprehenderit volup\",\n \"aliquip_a\": \"nostrud sit\"\n },\n \"host\": \"dolore nisi do\",\n \"httpVersion\": \"http1\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"enim magna\",\n \"metadata\": {\n \"sit_9\": \"sit qui\",\n \"irureb\": \"qui Excepteur quis labore\"\n },\n \"method\": \"deserunt dolor\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 3,\n \"persistCookies\": true,\n \"port\": 13174871,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"ullamco_19\": \"cillum conse\",\n \"non_3\": \"fugiat consequat sunt quis do\"\n }\n },\n \"query\": {},\n \"servername\": \"sint occaecat\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": -57415916.183924146,\n \"url\": \"https://example.com\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"creator\": {\n \"email\": \"esse voluptate cillum\",\n \"handle\": \"incididunt ut Excepteur\",\n \"name\": \"labore cupidatat ex ipsum\"\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"message\": \"id\",\n \"monitor_id\": 14287874,\n \"name\": \"ullamco ex dolor nulla\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": false,\n \"disableCors\": false,\n \"disableCsp\": false,\n \"enableProfiling\": false,\n \"follow_redirects\": false,\n \"httpVersion\": \"any\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -28440822,\n \"min_failure_duration\": -69371353,\n \"min_location_failed\": 91791243,\n \"monitor_name\": \"ut\",\n \"monitor_options\": {\n \"escalation_message\": \"in nulla ex dolor\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 85933118,\n \"renotify_occurrences\": 41354040\n },\n \"monitor_priority\": 1,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 95020496,\n \"interval\": -68705636.8852011\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 22729\n },\n \"public_id\": \"est ut\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": false,\n \"isCritical\": false,\n \"name\": \"ad sed\",\n \"noScreenshot\": true,\n \"params\": {},\n \"public_id\": \"veniam nulla cupidatat\",\n \"timeout\": 57915686,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": true,\n \"exitIfSucceed\": true,\n \"isCritical\": true,\n \"name\": \"sunt\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"nulla ipsum Duis eu Ut\",\n \"timeout\": -20985339,\n \"type\": \"assertElementContent\"\n }\n ],\n \"subtype\": \"http\",\n \"tags\": [\n \"dolor nostrud ea nisi voluptate\",\n \"esse eu\"\n ],\n \"type\": \"browser\"\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "- Synthetic is not activated for the user\n- Test is not owned by the user",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get the default locations",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/settings/default_locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"settings",
"default_locations"
]
},
"description": "Get the default locations settings."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/settings/default_locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"settings",
"default_locations"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "[\n \"aws:eu-west-3\"\n]"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/settings/default_locations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"settings",
"default_locations"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Fetch uptime for multiple tests",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"from_ts\": 0,\n \"to_ts\": 0,\n \"public_ids\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/uptimes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"uptimes"
]
},
"description": "Fetch uptime for multiple Synthetic tests by ID."
},
"response": [
{
"name": "OK.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"from_ts\": 0,\n \"to_ts\": 0,\n \"public_ids\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/uptimes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"uptimes"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "[\n {\n \"from_ts\": -81080691,\n \"overall\": {\n \"errors\": [\n {\n \"error_type\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_type\": \"\",\n \"error_message\": \"\"\n }\n ],\n \"group\": \"name\",\n \"history\": [\n [\n 1579212382,\n 0\n ]\n ],\n \"span_precision\": 2,\n \"uptime\": 99.99\n },\n \"public_id\": \"abc-def-123\",\n \"to_ts\": -60292580\n },\n {\n \"from_ts\": -79610592,\n \"overall\": {\n \"errors\": [\n {\n \"error_type\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_type\": \"\",\n \"error_message\": \"\"\n }\n ],\n \"group\": \"name\",\n \"history\": [\n [\n 1579212382,\n 0\n ]\n ],\n \"span_precision\": 2,\n \"uptime\": 99.99\n },\n \"public_id\": \"abc-def-123\",\n \"to_ts\": -12036309\n }\n]"
},
{
"name": "- JSON format is wrong",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"from_ts\": 0,\n \"to_ts\": 0,\n \"public_ids\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/uptimes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"uptimes"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"from_ts\": 0,\n \"to_ts\": 0,\n \"public_ids\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/uptimes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"uptimes"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"from_ts\": 0,\n \"to_ts\": 0,\n \"public_ids\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/uptimes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"uptimes"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Search Synthetic tests",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/search?text=fugiat id&include_full_config=true&search_suites=true&facets_only=true&start=0&count=50&sort=name,asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"search"
],
"query": [
{
"key": "text",
"value": "fugiat id",
"description": "The search query."
},
{
"key": "include_full_config",
"value": "true",
"description": "If true, include the full configuration for each test in the response."
},
{
"key": "search_suites",
"value": "true",
"description": "If true, returns suites instead of tests."
},
{
"key": "facets_only",
"value": "true",
"description": "If true, return only facets instead of full test details."
},
{
"key": "start",
"value": "0",
"description": "The offset from which to start returning results."
},
{
"key": "count",
"value": "50",
"description": "The maximum number of results to return."
},
{
"key": "sort",
"value": "name,asc",
"description": "The sort order for the results (e.g., `name,asc` or `name,desc`)."
}
]
},
"description": "Search for Synthetic tests and Test Suites."
},
"response": [
{
"name": "OK - Returns the list of Synthetic tests matching the search.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/search?text=fugiat id&include_full_config=true&search_suites=true&facets_only=true&start=0&count=50&sort=name,asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"search"
],
"query": [
{
"key": "text",
"value": "fugiat id",
"description": "The search query."
},
{
"key": "include_full_config",
"value": "true",
"description": "If true, include the full configuration for each test in the response."
},
{
"key": "search_suites",
"value": "true",
"description": "If true, returns suites instead of tests."
},
{
"key": "facets_only",
"value": "true",
"description": "If true, return only facets instead of full test details."
},
{
"key": "start",
"value": "0",
"description": "The offset from which to start returning results."
},
{
"key": "count",
"value": "50",
"description": "The maximum number of results to return."
},
{
"key": "sort",
"value": "name,asc",
"description": "The sort order for the results (e.g., `name,asc` or `name,desc`)."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"tests\": [\n {\n \"config\": {\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"volu\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"amet sunt\",\n \"filename\": \"veniam dolor irure\",\n \"updatedAt\": \"culpa reprehenderit elit ipsum commodo\"\n },\n \"key\": {\n \"content\": \"Excepteur\",\n \"filename\": \"ut dolor Duis laboris\",\n \"updatedAt\": \"ad et Lorem esse\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"quis esse aute mollit ad\",\n \"compressedProtoFile\": \"irure Excepteur nulla ex do\",\n \"disableAiaIntermediateFetching\": false,\n \"dnsServer\": \"ex tempor aliquip anim\",\n \"dnsServerPort\": -59421584,\n \"files\": [\n {\n \"bucketKey\": \"adipisicing dolo\",\n \"content\": \"ex velit nulla ut\",\n \"name\": \"Ut adipisicing\",\n \"originalFileName\": \"nostrud dolor Excepteur\",\n \"size\": 2825770,\n \"type\": \"non\"\n },\n {\n \"bucketKey\": \"sunt fugiat\",\n \"content\": \"do\",\n \"name\": \"officia eu labore\",\n \"originalFileName\": \"velit cupidatat\",\n \"size\": 341624,\n \"type\": \"occaecat pariatur\"\n }\n ],\n \"follow_redirects\": false,\n \"form\": {\n \"reprehenderit_a16\": \"ad anim et tempor\",\n \"minim28_\": \"id dolor\",\n \"non_74\": \"labore dolor\"\n },\n \"headers\": {\n \"inc26\": \"velit esse cillum\"\n },\n \"host\": \"do\",\n \"httpVersion\": \"any\",\n \"isMessageBase64Encoded\": false,\n \"message\": \"cillum laborum\",\n \"metadata\": {\n \"adipisicing_2d_\": \"ut reprehenderit dol\"\n },\n \"method\": \"adipisicing\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 3,\n \"persistCookies\": false,\n \"port\": -35694923,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"in7e_\": \"commod\",\n \"Ut_c\": \"adipisicing est eu in\"\n }\n },\n \"query\": {},\n \"servername\": \"do eiusmod sit\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": false,\n \"timeout\": -57526929.16111501,\n \"url\": \"https://example.com\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"creator\": {\n \"email\": \"nulla culpa in aliqua\",\n \"handle\": \"magna laboris in\",\n \"name\": \"pariatur quis reprehenderit dolore\"\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"message\": \"amet exercitation voluptate aute\",\n \"monitor_id\": -15149534,\n \"name\": \"exercitation adipisicing nulla\",\n \"options\": {\n \"accept_self_signed\": false,\n \"allow_insecure\": false,\n \"checkCertificateRevocation\": true,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": true,\n \"disableCors\": true,\n \"disableCsp\": false,\n \"enableProfiling\": true,\n \"follow_redirects\": false,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -17449253,\n \"min_failure_duration\": 31639462,\n \"min_location_failed\": -35550965,\n \"monitor_name\": \"ad aute in anim\",\n \"monitor_options\": {\n \"escalation_message\": \"non qui amet\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 2271687,\n \"renotify_occurrences\": 32041056\n },\n \"monitor_priority\": 2,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 21051534,\n \"interval\": 29949687.874488756\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 205898\n },\n \"public_id\": \"Ut id veniam Lorem laboris\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": false,\n \"isCritical\": false,\n \"name\": \"deserunt aute officia laboris\",\n \"noScreenshot\": true,\n \"params\": {},\n \"public_id\": \"velit exercitation id\",\n \"timeout\": -3498123,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"ullamco dolor cupidatat\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"aliquip quis consequat labore\",\n \"timeout\": -2513125,\n \"type\": \"assertElementContent\"\n }\n ],\n \"subtype\": \"http\",\n \"tags\": [\n \"exercitation\",\n \"adipisicing eu occaecat\"\n ],\n \"type\": \"browser\"\n },\n {\n \"config\": {\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"request\": {\n \"allow_insecure\": true,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"type\": \"web\",\n \"username\": \"my_username\"\n },\n \"body\": \"dolor Excepteur in\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"esse reprehende\",\n \"filename\": \"veniam sunt\",\n \"updatedAt\": \"ut pariatur sed\"\n },\n \"key\": {\n \"content\": \"aute\",\n \"filename\": \"sit adipi\",\n \"updatedAt\": \"c\"\n }\n },\n \"checkCertificateRevocation\": false,\n \"compressedJsonDescriptor\": \"in velit laboris et\",\n \"compressedProtoFile\": \"of\",\n \"disableAiaIntermediateFetching\": true,\n \"dnsServer\": \"\",\n \"dnsServerPort\": -32899771,\n \"files\": [\n {\n \"bucketKey\": \"culpa Excepteur\",\n \"content\": \"voluptate et\",\n \"name\": \"velit pariatur do\",\n \"originalFileName\": \"in culpa sunt magna\",\n \"size\": 670743,\n \"type\": \"non incididunt eu magna adipisicing\"\n },\n {\n \"bucketKey\": \"laboris sit elit incididunt\",\n \"content\": \"ea exercitation ipsum quis do\",\n \"name\": \"dolor qui incididunt non deserunt\",\n \"originalFileName\": \"incididunt\",\n \"size\": 829263,\n \"type\": \"incididunt sed ut velit Lorem\"\n }\n ],\n \"follow_redirects\": true,\n \"form\": {\n \"este6\": \"veniam magna\"\n },\n \"headers\": {\n \"nisi_c\": \"Duis veniam occaecat nisi\"\n },\n \"host\": \"et sit id ullamco\",\n \"httpVersion\": \"http2\",\n \"isMessageBase64Encoded\": true,\n \"message\": \"laborum enim\",\n \"metadata\": {\n \"dolore_9d\": \"et laborum exercitation\"\n },\n \"method\": \"dolore\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 4,\n \"persistCookies\": true,\n \"port\": -38198684,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"eiusmod67\": \"anim esse\",\n \"ametd\": \"qui dolore irure\"\n }\n },\n \"query\": {},\n \"servername\": \"nulla exercitation mollit\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": true,\n \"timeout\": -21710062.677636683,\n \"url\": \"https://example.com\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"creator\": {\n \"email\": \"tempor ullamco\",\n \"handle\": \"consectetur aliqua esse cupidatat deserunt\",\n \"name\": \"cillum non velit\"\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"message\": \"magna id officia occaecat\",\n \"monitor_id\": 15547925,\n \"name\": \"eiu\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": false,\n \"checkCertificateRevocation\": true,\n \"ci\": {\n \"executionRule\": \"blocking\"\n },\n \"device_ids\": [\n \"chrome.laptop_large\",\n \"chrome.laptop_large\"\n ],\n \"disableAiaIntermediateFetching\": false,\n \"disableCors\": false,\n \"disableCsp\": true,\n \"enableProfiling\": false,\n \"follow_redirects\": true,\n \"httpVersion\": \"http1\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -20850138,\n \"min_failure_duration\": 30560548,\n \"min_location_failed\": 46914207,\n \"monitor_name\": \"ad c\",\n \"monitor_options\": {\n \"escalation_message\": \"anim\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 42330487,\n \"renotify_occurrences\": -55228052\n },\n \"monitor_priority\": 3,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -813125,\n \"interval\": 32336444.830152363\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 407132\n },\n \"public_id\": \"dolor ut\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": true,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": false,\n \"isCritical\": false,\n \"name\": \"culpa et\",\n \"noScreenshot\": true,\n \"params\": {},\n \"public_id\": \"ipsum sit adipisicing\",\n \"timeout\": 96621516,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"alwaysExecute\": false,\n \"exitIfSucceed\": true,\n \"isCritical\": false,\n \"name\": \"nulla sunt exercitation Excepteur\",\n \"noScreenshot\": false,\n \"params\": {},\n \"public_id\": \"ut\",\n \"timeout\": 41171798,\n \"type\": \"assertElementContent\"\n }\n ],\n \"subtype\": \"http\",\n \"tags\": [\n \"ullamco nisi nostrud\",\n \"adipisicing laborum\"\n ],\n \"type\": \"browser\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/search?text=fugiat id&include_full_config=true&search_suites=true&facets_only=true&start=0&count=50&sort=name,asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"search"
],
"query": [
{
"key": "text",
"value": "fugiat id",
"description": "The search query."
},
{
"key": "include_full_config",
"value": "true",
"description": "If true, include the full configuration for each test in the response."
},
{
"key": "search_suites",
"value": "true",
"description": "If true, returns suites instead of tests."
},
{
"key": "facets_only",
"value": "true",
"description": "If true, return only facets instead of full test details."
},
{
"key": "start",
"value": "0",
"description": "The offset from which to start returning results."
},
{
"key": "count",
"value": "50",
"description": "The maximum number of results to return."
},
{
"key": "sort",
"value": "name,asc",
"description": "The sort order for the results (e.g., `name,asc` or `name,desc`)."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/search?text=fugiat id&include_full_config=true&search_suites=true&facets_only=true&start=0&count=50&sort=name,asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"search"
],
"query": [
{
"key": "text",
"value": "fugiat id",
"description": "The search query."
},
{
"key": "include_full_config",
"value": "true",
"description": "If true, include the full configuration for each test in the response."
},
{
"key": "search_suites",
"value": "true",
"description": "If true, returns suites instead of tests."
},
{
"key": "facets_only",
"value": "true",
"description": "If true, return only facets instead of full test details."
},
{
"key": "start",
"value": "0",
"description": "The offset from which to start returning results."
},
{
"key": "count",
"value": "50",
"description": "The maximum number of results to return."
},
{
"key": "sort",
"value": "name,asc",
"description": "The sort order for the results (e.g., `name,asc` or `name,desc`)."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/search?text=fugiat id&include_full_config=true&search_suites=true&facets_only=true&start=0&count=50&sort=name,asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"search"
],
"query": [
{
"key": "text",
"value": "fugiat id",
"description": "The search query."
},
{
"key": "include_full_config",
"value": "true",
"description": "If true, include the full configuration for each test in the response."
},
{
"key": "search_suites",
"value": "true",
"description": "If true, returns suites instead of tests."
},
{
"key": "facets_only",
"value": "true",
"description": "If true, return only facets instead of full test details."
},
{
"key": "start",
"value": "0",
"description": "The offset from which to start returning results."
},
{
"key": "count",
"value": "50",
"description": "The maximum number of results to return."
},
{
"key": "sort",
"value": "name,asc",
"description": "The sort order for the results (e.g., `name,asc` or `name,desc`)."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Datadog Synthetic Monitoring uses simulated user requests and browser rendering to help you ensure uptime,\nidentify regional issues, and track your application performance. Synthetic tests come in\ntwo different flavors, [API tests](https://docs.datadoghq.com/synthetics/api_tests/?tab=httptest)\nand [browser tests](https://docs.datadoghq.com/synthetics/browser_tests). You can use Datadog's API to\nmanage both test types programmatically.\n\nFor more information, see the [Synthetic Monitoring documentation](https://docs.datadoghq.com/synthetics/).",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Tags",
"item": [
{
"name": "Get Tags",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "When specified, filters host list to those tags with the specified source.",
"disabled": true
}
]
},
"description": "Return a mapping of tags to hosts for your whole infrastructure."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "When specified, filters host list to those tags with the specified source.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"tags\": {\n \"occaecat_22\": [\n \"test.metric.host\",\n \"test.metric.host\"\n ],\n \"amet_19\": [\n \"test.metric.host\",\n \"test.metric.host\"\n ]\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "When specified, filters host list to those tags with the specified source.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "When specified, filters host list to those tags with the specified source.",
"disabled": true
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "When specified, filters host list to those tags with the specified source.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get host tags",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "Source to filter.",
"disabled": true
}
],
"variable": [
{
"key": "host_name",
"value": "pariatur"
}
]
},
"description": "Return the list of tags that apply to a given host."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "Source to filter.",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"host\": \"test.host\",\n \"tags\": [\n \"environment:production\",\n \"environment:production\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "Source to filter.",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "Source to filter.",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "Source to filter.",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Add tags to a host",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"host\": \"test.host\",\n \"tags\": [\n \"environment:production\",\n \"environment:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "chef",
"description": "The source of the tags.\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).",
"disabled": true
}
],
"variable": [
{
"key": "host_name",
"value": "pariatur"
}
]
},
"description": "This endpoint allows you to add new tags to a host,\noptionally specifying where these tags come from."
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"host\": \"test.host\",\n \"tags\": [\n \"environment:production\",\n \"environment:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "chef",
"description": "The source of the tags.\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"host\": \"test.host\",\n \"tags\": [\n \"environment:production\",\n \"environment:production\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"host\": \"test.host\",\n \"tags\": [\n \"environment:production\",\n \"environment:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "chef",
"description": "The source of the tags.\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"host\": \"test.host\",\n \"tags\": [\n \"environment:production\",\n \"environment:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "chef",
"description": "The source of the tags.\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"host\": \"test.host\",\n \"tags\": [\n \"environment:production\",\n \"environment:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "chef",
"description": "The source of the tags.\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update host tags",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"host\": \"test.host\",\n \"tags\": [\n \"environment:production\",\n \"environment:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "The source of the tags (for example chef, puppet).\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)",
"disabled": true
}
],
"variable": [
{
"key": "host_name",
"value": "pariatur"
}
]
},
"description": "This endpoint allows you to update/replace all tags in\nan integration source with those supplied in the request."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"host\": \"test.host\",\n \"tags\": [\n \"environment:production\",\n \"environment:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "The source of the tags (for example chef, puppet).\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"host\": \"test.host\",\n \"tags\": [\n \"environment:production\",\n \"environment:production\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"host\": \"test.host\",\n \"tags\": [\n \"environment:production\",\n \"environment:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "The source of the tags (for example chef, puppet).\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"host\": \"test.host\",\n \"tags\": [\n \"environment:production\",\n \"environment:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "The source of the tags (for example chef, puppet).\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"host\": \"test.host\",\n \"tags\": [\n \"environment:production\",\n \"environment:production\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "The source of the tags (for example chef, puppet).\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Remove host tags",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "The source of the tags (for example chef, puppet).\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).",
"disabled": true
}
],
"variable": [
{
"key": "host_name",
"value": "pariatur"
}
]
},
"description": "This endpoint allows you to remove all user-assigned tags\nfor a single host."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "The source of the tags (for example chef, puppet).\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "The source of the tags (for example chef, puppet).\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "The source of the tags (for example chef, puppet).\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"tags",
"hosts",
":host_name"
],
"query": [
{
"key": "source",
"value": "pariatur",
"description": "The source of the tags (for example chef, puppet).\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).",
"disabled": true
}
],
"variable": [
{
"key": "host_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "The tag endpoint allows you to assign tags to hosts,\nfor example: `role:database`. Those tags are applied to\nall metrics sent by the host. Refer to hosts by name\n(`yourhost.example.com`) when fetching and applying\ntags to a particular host.\n\nThe component of your infrastructure responsible for a tag is identified\nby a source. For example, some valid sources include nagios, hudson, jenkins,\nusers, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc.\n\nRead more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/).",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Teams",
"item": [
{
"name": "Get all teams",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
],
"query": [
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "sort",
"value": "-user_count",
"description": "Specifies the order of the returned teams",
"disabled": true
},
{
"key": "include",
"value": "user_team_permissions",
"description": "Included related resources optionally requested. Allowed enum values: `team_links, user_team_permissions`",
"disabled": true
},
{
"key": "include",
"value": "team_links",
"description": "Included related resources optionally requested. Allowed enum values: `team_links, user_team_permissions`",
"disabled": true
},
{
"key": "filter[keyword]",
"value": "pariatur consequat",
"description": "Search query. Can be team name, team handle, or email of team member",
"disabled": true
},
{
"key": "filter[me]",
"value": "false",
"description": "When true, only returns teams the current user belongs to",
"disabled": true
},
{
"key": "fields[team]",
"value": "link_count,team_links",
"description": "List of fields that need to be fetched.",
"disabled": true
}
]
},
"description": "Get all teams.\nCan be used to search for teams using the `filter[keyword]` and `filter[me]` query parameters."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
],
"query": [
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "sort",
"value": "-user_count",
"description": "Specifies the order of the returned teams",
"disabled": true
},
{
"key": "include",
"value": "team_links",
"description": "Included related resources optionally requested. Allowed enum values: `team_links, user_team_permissions`",
"disabled": true
},
{
"key": "filter[keyword]",
"value": "pariatur consequat",
"description": "Search query. Can be team name, team handle, or email of team member",
"disabled": true
},
{
"key": "filter[me]",
"value": "false",
"description": "When true, only returns teams the current user belongs to",
"disabled": true
},
{
"key": "fields[team]",
"value": "link_count,team_links",
"description": "List of fields that need to be fetched.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": -26452719,\n \"created_at\": \"1984-04-10T06:40:07.216Z\",\n \"description\": \"amet laboris Lorem\",\n \"hidden_modules\": [\n \"reprehenderit sint ipsum consequat\",\n \"proident Lorem\"\n ],\n \"link_count\": 1173799117,\n \"modified_at\": \"1998-08-01T22:42:17.421Z\",\n \"summary\": \"irure mollit in ullamco\",\n \"user_count\": 1307006134,\n \"visible_modules\": [\n \"et tempor do quis\",\n \"ullamco\"\n ]\n },\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"team\",\n \"relationships\": {\n \"team_links\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n },\n \"user_team_permissions\": {\n \"data\": {\n \"id\": \"UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595\",\n \"type\": \"user_team_permissions\"\n },\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n }\n }\n },\n {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": 54292428,\n \"created_at\": \"1974-08-19T22:38:08.357Z\",\n \"description\": \"eiusmod Lore\",\n \"hidden_modules\": [\n \"nulla pariatur\",\n \"anim commodo i\"\n ],\n \"link_count\": 1589753318,\n \"modified_at\": \"1993-02-06T03:25:52.679Z\",\n \"summary\": \"ad dolor Duis\",\n \"user_count\": 1921112546,\n \"visible_modules\": [\n \"in nisi aute\",\n \"officia qui est\"\n ]\n },\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"team\",\n \"relationships\": {\n \"team_links\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n },\n \"user_team_permissions\": {\n \"data\": {\n \"id\": \"UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595\",\n \"type\": \"user_team_permissions\"\n },\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n }\n }\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1975-08-01T23:53:43.357Z\",\n \"disabled\": true,\n \"email\": \"amet do sint in\",\n \"handle\": \"esse laborum id minim\",\n \"icon\": \"consequat mollit\",\n \"modified_at\": \"1998-08-10T03:42:37.797Z\",\n \"name\": \"officia aliquip commodo aliqua\",\n \"service_account\": false,\n \"status\": \"occaecat eu non\",\n \"title\": \"id\",\n \"verified\": false\n },\n \"id\": \"laborum eiusm\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1973-11-02T06:26:02.982Z\",\n \"disabled\": false,\n \"email\": \"nostrud offi\",\n \"handle\": \"fugiat dolor ex mollit\",\n \"icon\": \"minim irure adipisicing nostrud\",\n \"modified_at\": \"2022-02-18T12:01:57.414Z\",\n \"name\": \"ad pariatur veniam ullamco laboris\",\n \"service_account\": false,\n \"status\": \"deserunt eu off\",\n \"title\": \"dolore ad\",\n \"verified\": false\n },\n \"id\": \"commodo adipisicing labore\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ],\n \"links\": {\n \"first\": \"commodo elit nostrud\",\n \"last\": \"elit Duis exercitation\",\n \"next\": \"aliquip dolore elit reprehenderit\",\n \"prev\": \"magna dolore ullamc\",\n \"self\": \"Duis\"\n },\n \"meta\": {\n \"pagination\": {\n \"first_offset\": -50540452,\n \"last_offset\": -27508711,\n \"limit\": -86404252,\n \"next_offset\": -56761729,\n \"offset\": -64815889,\n \"prev_offset\": -72739078,\n \"total\": -12840076,\n \"type\": \"fugiat magna dolor est aliqua\"\n }\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
],
"query": [
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "sort",
"value": "-user_count",
"description": "Specifies the order of the returned teams",
"disabled": true
},
{
"key": "include",
"value": "team_links",
"description": "Included related resources optionally requested. Allowed enum values: `team_links, user_team_permissions`",
"disabled": true
},
{
"key": "filter[keyword]",
"value": "pariatur consequat",
"description": "Search query. Can be team name, team handle, or email of team member",
"disabled": true
},
{
"key": "filter[me]",
"value": "false",
"description": "When true, only returns teams the current user belongs to",
"disabled": true
},
{
"key": "fields[team]",
"value": "link_count,team_links",
"description": "List of fields that need to be fetched.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
],
"query": [
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "sort",
"value": "-user_count",
"description": "Specifies the order of the returned teams",
"disabled": true
},
{
"key": "include",
"value": "team_links",
"description": "Included related resources optionally requested. Allowed enum values: `team_links, user_team_permissions`",
"disabled": true
},
{
"key": "filter[keyword]",
"value": "pariatur consequat",
"description": "Search query. Can be team name, team handle, or email of team member",
"disabled": true
},
{
"key": "filter[me]",
"value": "false",
"description": "When true, only returns teams the current user belongs to",
"disabled": true
},
{
"key": "fields[team]",
"value": "link_count,team_links",
"description": "List of fields that need to be fetched.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get user memberships",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_uuid/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_uuid",
"memberships"
],
"variable": [
{
"key": "user_uuid",
"value": "pariatur consequat"
}
]
},
"description": "Get a list of memberships for a user"
},
"response": [
{
"name": "Represents a user's association to a team",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_uuid/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_uuid",
"memberships"
],
"variable": [
{
"key": "user_uuid"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": \"TeamMembership-aeadc05e-98a8-11ec-ac2c-da7ad0900001-38835\",\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"esse commodo Excepteur eu\",\n \"provisioned_by_id\": \"consectetur irure laboris\",\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"team\": {\n \"data\": {\n \"id\": \"d7e15d9d-d346-43da-81d8-3d9e71d9a5e9\",\n \"type\": \"team\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"id\": \"TeamMembership-aeadc05e-98a8-11ec-ac2c-da7ad0900001-38835\",\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"s\",\n \"provisioned_by_id\": \"aliqua\",\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"team\": {\n \"data\": {\n \"id\": \"d7e15d9d-d346-43da-81d8-3d9e71d9a5e9\",\n \"type\": \"team\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"users\"\n }\n }\n }\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1988-05-11T22:22:19.889Z\",\n \"disabled\": true,\n \"email\": \"aliquip \",\n \"handle\": \"et Excepteur\",\n \"icon\": \"Duis occaecat cupidatat exercitation\",\n \"modified_at\": \"1985-07-05T02:31:35.108Z\",\n \"name\": \"quis officia est\",\n \"service_account\": true,\n \"status\": \"esse labore exercit\",\n \"title\": \"ut a\",\n \"verified\": false\n },\n \"id\": \"enim tempor\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2008-09-23T15:15:54.365Z\",\n \"disabled\": true,\n \"email\": \"cupidatat adipis\",\n \"handle\": \"nisi quis consectetur magna\",\n \"icon\": \"dolor nostrud in non\",\n \"modified_at\": \"1994-10-24T09:20:13.457Z\",\n \"name\": \"ea adipisicing amet sunt aute\",\n \"service_account\": false,\n \"status\": \"in laborum dolore\",\n \"title\": \"aliqu\",\n \"verified\": false\n },\n \"id\": \"Duis laborum occaecat\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ],\n \"links\": {\n \"first\": \"qui\",\n \"last\": \"cupidatat ullamco cillum voluptate culpa\",\n \"next\": \"sed tempor\",\n \"prev\": \"cillum elit Ut\",\n \"self\": \"proident veniam\"\n },\n \"meta\": {\n \"pagination\": {\n \"first_offset\": -46838774,\n \"last_offset\": -67986253,\n \"limit\": -56520489,\n \"next_offset\": 4196077,\n \"offset\": 7408868,\n \"prev_offset\": -2739117,\n \"total\": -7852322,\n \"type\": \"aliquip ad dolore\"\n }\n }\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_uuid/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_uuid",
"memberships"
],
"variable": [
{
"key": "user_uuid"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_uuid/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_uuid",
"memberships"
],
"variable": [
{
"key": "user_uuid"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a team",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": 80899457,\n \"description\": \"Ut commodo ullamco consectetur cupidatat\",\n \"hidden_modules\": [\n \"pariatur enim\",\n \"eiusmod\"\n ],\n \"visible_modules\": [\n \"magna sunt anim non\",\n \"in consectetur qui\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"users\": {\n \"data\": []\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
]
},
"description": "Create a new team.\nUser IDs passed through the `users` relationship field are added to the team."
},
"response": [
{
"name": "CREATED",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": 80899457,\n \"description\": \"Ut commodo ullamco consectetur cupidatat\",\n \"hidden_modules\": [\n \"pariatur enim\",\n \"eiusmod\"\n ],\n \"visible_modules\": [\n \"magna sunt anim non\",\n \"in consectetur qui\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"users\": {\n \"data\": []\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": 98306089,\n \"created_at\": \"1950-07-06T08:22:24.965Z\",\n \"description\": \"Excepteur proident exercitation laborum\",\n \"hidden_modules\": [\n \"eu enim Duis incididunt\",\n \"do fugiat\"\n ],\n \"link_count\": 1103085133,\n \"modified_at\": \"1993-10-15T19:34:32.144Z\",\n \"summary\": \"ad dolor\",\n \"user_count\": 225486167,\n \"visible_modules\": [\n \"culpa aliquip ut Excepteur veniam\",\n \"ipsum fugiat\"\n ]\n },\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"team\",\n \"relationships\": {\n \"team_links\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n },\n \"user_team_permissions\": {\n \"data\": {\n \"id\": \"UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595\",\n \"type\": \"user_team_permissions\"\n },\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n }\n }\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": 80899457,\n \"description\": \"Ut commodo ullamco consectetur cupidatat\",\n \"hidden_modules\": [\n \"pariatur enim\",\n \"eiusmod\"\n ],\n \"visible_modules\": [\n \"magna sunt anim non\",\n \"in consectetur qui\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"users\": {\n \"data\": []\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": 80899457,\n \"description\": \"Ut commodo ullamco consectetur cupidatat\",\n \"hidden_modules\": [\n \"pariatur enim\",\n \"eiusmod\"\n ],\n \"visible_modules\": [\n \"magna sunt anim non\",\n \"in consectetur qui\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"users\": {\n \"data\": []\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": 80899457,\n \"description\": \"Ut commodo ullamco consectetur cupidatat\",\n \"hidden_modules\": [\n \"pariatur enim\",\n \"eiusmod\"\n ],\n \"visible_modules\": [\n \"magna sunt anim non\",\n \"in consectetur qui\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"users\": {\n \"data\": []\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a team",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id",
"value": "pariatur consequat"
}
]
},
"description": "Get a single team using the team's `id`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": 98306089,\n \"created_at\": \"1950-07-06T08:22:24.965Z\",\n \"description\": \"Excepteur proident exercitation laborum\",\n \"hidden_modules\": [\n \"eu enim Duis incididunt\",\n \"do fugiat\"\n ],\n \"link_count\": 1103085133,\n \"modified_at\": \"1993-10-15T19:34:32.144Z\",\n \"summary\": \"ad dolor\",\n \"user_count\": 225486167,\n \"visible_modules\": [\n \"culpa aliquip ut Excepteur veniam\",\n \"ipsum fugiat\"\n ]\n },\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"team\",\n \"relationships\": {\n \"team_links\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n },\n \"user_team_permissions\": {\n \"data\": {\n \"id\": \"UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595\",\n \"type\": \"user_team_permissions\"\n },\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n }\n }\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a team",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": -58393442,\n \"color\": 6,\n \"description\": \"nulla Excepteur co\",\n \"hidden_modules\": [\n \"dolor amet\",\n \"aute Ut velit\"\n ],\n \"visible_modules\": [\n \"mollit non fugiat eiusmod\",\n \"Ut irure\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"team_links\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id",
"value": "pariatur consequat"
}
]
},
"description": "Update a team using the team's `id`.\nIf the `team_links` relationship is present, the associated links are updated to be in the order they appear in the array, and any existing team links not present are removed."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": -58393442,\n \"color\": 6,\n \"description\": \"nulla Excepteur co\",\n \"hidden_modules\": [\n \"dolor amet\",\n \"aute Ut velit\"\n ],\n \"visible_modules\": [\n \"mollit non fugiat eiusmod\",\n \"Ut irure\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"team_links\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": 98306089,\n \"created_at\": \"1950-07-06T08:22:24.965Z\",\n \"description\": \"Excepteur proident exercitation laborum\",\n \"hidden_modules\": [\n \"eu enim Duis incididunt\",\n \"do fugiat\"\n ],\n \"link_count\": 1103085133,\n \"modified_at\": \"1993-10-15T19:34:32.144Z\",\n \"summary\": \"ad dolor\",\n \"user_count\": 225486167,\n \"visible_modules\": [\n \"culpa aliquip ut Excepteur veniam\",\n \"ipsum fugiat\"\n ]\n },\n \"id\": \"aeadc05e-98a8-11ec-ac2c-da7ad0900001\",\n \"type\": \"team\",\n \"relationships\": {\n \"team_links\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n },\n \"user_team_permissions\": {\n \"data\": {\n \"id\": \"UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595\",\n \"type\": \"user_team_permissions\"\n },\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n }\n }\n }\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": -58393442,\n \"color\": 6,\n \"description\": \"nulla Excepteur co\",\n \"hidden_modules\": [\n \"dolor amet\",\n \"aute Ut velit\"\n ],\n \"visible_modules\": [\n \"mollit non fugiat eiusmod\",\n \"Ut irure\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"team_links\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": -58393442,\n \"color\": 6,\n \"description\": \"nulla Excepteur co\",\n \"hidden_modules\": [\n \"dolor amet\",\n \"aute Ut velit\"\n ],\n \"visible_modules\": [\n \"mollit non fugiat eiusmod\",\n \"Ut irure\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"team_links\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": -58393442,\n \"color\": 6,\n \"description\": \"nulla Excepteur co\",\n \"hidden_modules\": [\n \"dolor amet\",\n \"aute Ut velit\"\n ],\n \"visible_modules\": [\n \"mollit non fugiat eiusmod\",\n \"Ut irure\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"team_links\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": -58393442,\n \"color\": 6,\n \"description\": \"nulla Excepteur co\",\n \"hidden_modules\": [\n \"dolor amet\",\n \"aute Ut velit\"\n ],\n \"visible_modules\": [\n \"mollit non fugiat eiusmod\",\n \"Ut irure\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"team_links\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"example-team\",\n \"name\": \"Example Team\",\n \"avatar\": \"🥑\",\n \"banner\": -58393442,\n \"color\": 6,\n \"description\": \"nulla Excepteur co\",\n \"hidden_modules\": [\n \"dolor amet\",\n \"aute Ut velit\"\n ],\n \"visible_modules\": [\n \"mollit non fugiat eiusmod\",\n \"Ut irure\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"team_links\": {\n \"data\": [\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"f9bb8444-af7f-11ec-ac2c-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Remove a team",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id",
"value": "pariatur consequat"
}
]
},
"description": "Remove a team using the team's `id`."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get team memberships",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "-manager_name",
"description": "Specifies the order of returned team memberships",
"disabled": true
},
{
"key": "filter[keyword]",
"value": "pariatur consequat",
"description": "Search query, can be user email or name",
"disabled": true
}
],
"variable": [
{
"key": "team_id",
"value": "pariatur consequat"
}
]
},
"description": "Get a paginated list of members for a team"
},
"response": [
{
"name": "Represents a user's association to a team",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "-manager_name",
"description": "Specifies the order of returned team memberships",
"disabled": true
},
{
"key": "filter[keyword]",
"value": "pariatur consequat",
"description": "Search query, can be user email or name",
"disabled": true
}
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": \"TeamMembership-aeadc05e-98a8-11ec-ac2c-da7ad0900001-38835\",\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"esse commodo Excepteur eu\",\n \"provisioned_by_id\": \"consectetur irure laboris\",\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"team\": {\n \"data\": {\n \"id\": \"d7e15d9d-d346-43da-81d8-3d9e71d9a5e9\",\n \"type\": \"team\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"id\": \"TeamMembership-aeadc05e-98a8-11ec-ac2c-da7ad0900001-38835\",\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"s\",\n \"provisioned_by_id\": \"aliqua\",\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"team\": {\n \"data\": {\n \"id\": \"d7e15d9d-d346-43da-81d8-3d9e71d9a5e9\",\n \"type\": \"team\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"users\"\n }\n }\n }\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"1988-05-11T22:22:19.889Z\",\n \"disabled\": true,\n \"email\": \"aliquip \",\n \"handle\": \"et Excepteur\",\n \"icon\": \"Duis occaecat cupidatat exercitation\",\n \"modified_at\": \"1985-07-05T02:31:35.108Z\",\n \"name\": \"quis officia est\",\n \"service_account\": true,\n \"status\": \"esse labore exercit\",\n \"title\": \"ut a\",\n \"verified\": false\n },\n \"id\": \"enim tempor\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2008-09-23T15:15:54.365Z\",\n \"disabled\": true,\n \"email\": \"cupidatat adipis\",\n \"handle\": \"nisi quis consectetur magna\",\n \"icon\": \"dolor nostrud in non\",\n \"modified_at\": \"1994-10-24T09:20:13.457Z\",\n \"name\": \"ea adipisicing amet sunt aute\",\n \"service_account\": false,\n \"status\": \"in laborum dolore\",\n \"title\": \"aliqu\",\n \"verified\": false\n },\n \"id\": \"Duis laborum occaecat\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ],\n \"links\": {\n \"first\": \"qui\",\n \"last\": \"cupidatat ullamco cillum voluptate culpa\",\n \"next\": \"sed tempor\",\n \"prev\": \"cillum elit Ut\",\n \"self\": \"proident veniam\"\n },\n \"meta\": {\n \"pagination\": {\n \"first_offset\": -46838774,\n \"last_offset\": -67986253,\n \"limit\": -56520489,\n \"next_offset\": 4196077,\n \"offset\": 7408868,\n \"prev_offset\": -2739117,\n \"total\": -7852322,\n \"type\": \"aliquip ad dolore\"\n }\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "-manager_name",
"description": "Specifies the order of returned team memberships",
"disabled": true
},
{
"key": "filter[keyword]",
"value": "pariatur consequat",
"description": "Search query, can be user email or name",
"disabled": true
}
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "-manager_name",
"description": "Specifies the order of returned team memberships",
"disabled": true
},
{
"key": "filter[keyword]",
"value": "pariatur consequat",
"description": "Search query, can be user email or name",
"disabled": true
}
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "-manager_name",
"description": "Specifies the order of returned team memberships",
"disabled": true
},
{
"key": "filter[keyword]",
"value": "pariatur consequat",
"description": "Search query, can be user email or name",
"disabled": true
}
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Add a user to a team",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"laborum laboris ut\",\n \"provisioned_by_id\": \"laborum eu officia sed\",\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"team\": {\n \"data\": {\n \"id\": \"d7e15d9d-d346-43da-81d8-3d9e71d9a5e9\",\n \"type\": \"team\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"users\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships"
],
"variable": [
{
"key": "team_id",
"value": "pariatur consequat"
}
]
},
"description": "Add a user to a team."
},
"response": [
{
"name": "Represents a user's association to a team",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"laborum laboris ut\",\n \"provisioned_by_id\": \"laborum eu officia sed\",\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"team\": {\n \"data\": {\n \"id\": \"d7e15d9d-d346-43da-81d8-3d9e71d9a5e9\",\n \"type\": \"team\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"users\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"TeamMembership-aeadc05e-98a8-11ec-ac2c-da7ad0900001-38835\",\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"dolor dolor ullamco nulla\",\n \"provisioned_by_id\": \"Excepteur consectetur\",\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"team\": {\n \"data\": {\n \"id\": \"d7e15d9d-d346-43da-81d8-3d9e71d9a5e9\",\n \"type\": \"team\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"users\"\n }\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"2011-10-01T09:44:15.925Z\",\n \"disabled\": true,\n \"email\": \"cillum nostrud Ut\",\n \"handle\": \"ut nostrud anim velit\",\n \"icon\": \"sed\",\n \"modified_at\": \"1985-11-21T04:57:16.564Z\",\n \"name\": \"tempor labore\",\n \"service_account\": false,\n \"status\": \"magna fugiat\",\n \"title\": \"deserunt commodo aliquip ad\",\n \"verified\": true\n },\n \"id\": \"do ut laborum\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1946-08-10T09:52:09.778Z\",\n \"disabled\": true,\n \"email\": \"incididunt ipsum anim aliqua\",\n \"handle\": \"tempor do\",\n \"icon\": \"veniam\",\n \"modified_at\": \"2014-09-05T07:24:47.060Z\",\n \"name\": \"adipisicing exercitation\",\n \"service_account\": true,\n \"status\": \"irure consectetur amet\",\n \"title\": \"proident nulla\",\n \"verified\": true\n },\n \"id\": \"labore dolore aute in\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"laborum laboris ut\",\n \"provisioned_by_id\": \"laborum eu officia sed\",\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"team\": {\n \"data\": {\n \"id\": \"d7e15d9d-d346-43da-81d8-3d9e71d9a5e9\",\n \"type\": \"team\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"users\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"laborum laboris ut\",\n \"provisioned_by_id\": \"laborum eu officia sed\",\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"team\": {\n \"data\": {\n \"id\": \"d7e15d9d-d346-43da-81d8-3d9e71d9a5e9\",\n \"type\": \"team\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"users\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"laborum laboris ut\",\n \"provisioned_by_id\": \"laborum eu officia sed\",\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"team\": {\n \"data\": {\n \"id\": \"d7e15d9d-d346-43da-81d8-3d9e71d9a5e9\",\n \"type\": \"team\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"users\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"laborum laboris ut\",\n \"provisioned_by_id\": \"laborum eu officia sed\",\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"team\": {\n \"data\": {\n \"id\": \"d7e15d9d-d346-43da-81d8-3d9e71d9a5e9\",\n \"type\": \"team\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"users\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Remove a user from a team",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships",
":user_id"
],
"variable": [
{
"key": "team_id",
"value": "pariatur consequat"
},
{
"key": "user_id",
"value": "pariatur consequat"
}
]
},
"description": "Remove a user from a team."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships",
":user_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "user_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships",
":user_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "user_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships",
":user_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "user_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships",
":user_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "user_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a user's membership attributes on a team",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"exercitation veniam\",\n \"provisioned_by_id\": \"reprehenderit laborum\",\n \"role\": \"admin\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships",
":user_id"
],
"variable": [
{
"key": "team_id",
"value": "pariatur consequat"
},
{
"key": "user_id",
"value": "pariatur consequat"
}
]
},
"description": "Update a user's membership attributes on a team."
},
"response": [
{
"name": "Represents a user's association to a team",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"exercitation veniam\",\n \"provisioned_by_id\": \"reprehenderit laborum\",\n \"role\": \"admin\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships",
":user_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"TeamMembership-aeadc05e-98a8-11ec-ac2c-da7ad0900001-38835\",\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"dolor dolor ullamco nulla\",\n \"provisioned_by_id\": \"Excepteur consectetur\",\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"team\": {\n \"data\": {\n \"id\": \"d7e15d9d-d346-43da-81d8-3d9e71d9a5e9\",\n \"type\": \"team\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"users\"\n }\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"2011-10-01T09:44:15.925Z\",\n \"disabled\": true,\n \"email\": \"cillum nostrud Ut\",\n \"handle\": \"ut nostrud anim velit\",\n \"icon\": \"sed\",\n \"modified_at\": \"1985-11-21T04:57:16.564Z\",\n \"name\": \"tempor labore\",\n \"service_account\": false,\n \"status\": \"magna fugiat\",\n \"title\": \"deserunt commodo aliquip ad\",\n \"verified\": true\n },\n \"id\": \"do ut laborum\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"1946-08-10T09:52:09.778Z\",\n \"disabled\": true,\n \"email\": \"incididunt ipsum anim aliqua\",\n \"handle\": \"tempor do\",\n \"icon\": \"veniam\",\n \"modified_at\": \"2014-09-05T07:24:47.060Z\",\n \"name\": \"adipisicing exercitation\",\n \"service_account\": true,\n \"status\": \"irure consectetur amet\",\n \"title\": \"proident nulla\",\n \"verified\": true\n },\n \"id\": \"labore dolore aute in\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"exercitation veniam\",\n \"provisioned_by_id\": \"reprehenderit laborum\",\n \"role\": \"admin\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships",
":user_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "user_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"exercitation veniam\",\n \"provisioned_by_id\": \"reprehenderit laborum\",\n \"role\": \"admin\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships",
":user_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "user_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_memberships\",\n \"attributes\": {\n \"provisioned_by\": \"exercitation veniam\",\n \"provisioned_by_id\": \"reprehenderit laborum\",\n \"role\": \"admin\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/memberships/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"memberships",
":user_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "user_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get links for a team",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links"
],
"variable": [
{
"key": "team_id",
"value": "pariatur consequat"
}
]
},
"description": "Get all links for a given team."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 1965062202,\n \"team_id\": \"ex eu consequat Ut cillum\"\n },\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"team_links\"\n },\n {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 129182156,\n \"team_id\": \"Ut velit\"\n },\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"team_links\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a team link",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 662826406,\n \"team_id\": \"deserunt ea eu\"\n },\n \"type\": \"team_links\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links"
],
"variable": [
{
"key": "team_id",
"value": "pariatur consequat"
}
]
},
"description": "Add a new link to a team."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 662826406,\n \"team_id\": \"deserunt ea eu\"\n },\n \"type\": \"team_links\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 1265679053,\n \"team_id\": \"ad proident amet cupidatat\"\n },\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"team_links\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 662826406,\n \"team_id\": \"deserunt ea eu\"\n },\n \"type\": \"team_links\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 662826406,\n \"team_id\": \"deserunt ea eu\"\n },\n \"type\": \"team_links\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 662826406,\n \"team_id\": \"deserunt ea eu\"\n },\n \"type\": \"team_links\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 662826406,\n \"team_id\": \"deserunt ea eu\"\n },\n \"type\": \"team_links\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a team link",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links/:link_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links",
":link_id"
],
"variable": [
{
"key": "team_id",
"value": "pariatur consequat"
},
{
"key": "link_id",
"value": "pariatur consequat"
}
]
},
"description": "Get a single link for a team."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links/:link_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links",
":link_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "link_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 1265679053,\n \"team_id\": \"ad proident amet cupidatat\"\n },\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"team_links\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links/:link_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links",
":link_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "link_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links/:link_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links",
":link_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "link_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links/:link_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links",
":link_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "link_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a team link",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 662826406,\n \"team_id\": \"deserunt ea eu\"\n },\n \"type\": \"team_links\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links/:link_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links",
":link_id"
],
"variable": [
{
"key": "team_id",
"value": "pariatur consequat"
},
{
"key": "link_id",
"value": "pariatur consequat"
}
]
},
"description": "Update a team link."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 662826406,\n \"team_id\": \"deserunt ea eu\"\n },\n \"type\": \"team_links\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links/:link_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links",
":link_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "link_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 1265679053,\n \"team_id\": \"ad proident amet cupidatat\"\n },\n \"id\": \"b8626d7e-cedd-11eb-abf5-da7ad0900001\",\n \"type\": \"team_links\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 662826406,\n \"team_id\": \"deserunt ea eu\"\n },\n \"type\": \"team_links\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links/:link_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links",
":link_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "link_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 662826406,\n \"team_id\": \"deserunt ea eu\"\n },\n \"type\": \"team_links\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links/:link_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links",
":link_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "link_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"label\": \"Link label\",\n \"url\": \"https://example.com\",\n \"position\": 662826406,\n \"team_id\": \"deserunt ea eu\"\n },\n \"type\": \"team_links\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links/:link_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links",
":link_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "link_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Remove a team link",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links/:link_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links",
":link_id"
],
"variable": [
{
"key": "team_id",
"value": "pariatur consequat"
},
{
"key": "link_id",
"value": "pariatur consequat"
}
]
},
"description": "Remove a link from a team."
},
"response": [
{
"name": "No Content",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links/:link_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links",
":link_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "link_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links/:link_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links",
":link_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "link_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links/:link_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links",
":link_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "link_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/links/:link_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"links",
":link_id"
],
"variable": [
{
"key": "team_id"
},
{
"key": "link_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get permission settings for a team",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/permission-settings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"permission-settings"
],
"variable": [
{
"key": "team_id",
"value": "pariatur consequat"
}
]
},
"description": "Get all permission settings for a given team."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/permission-settings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"permission-settings"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": \"TeamPermission-aeadc05e-98a8-11ec-ac2c-da7ad0900001-edit\",\n \"type\": \"team_permission_settings\",\n \"attributes\": {\n \"action\": \"manage_membership\",\n \"editable\": true,\n \"options\": [\n \"user_access_manage\",\n \"user_access_manage\"\n ],\n \"title\": \"ad laborum\",\n \"value\": \"teams_manage\"\n }\n },\n {\n \"id\": \"TeamPermission-aeadc05e-98a8-11ec-ac2c-da7ad0900001-edit\",\n \"type\": \"team_permission_settings\",\n \"attributes\": {\n \"action\": \"manage_membership\",\n \"editable\": true,\n \"options\": [\n \"organization\",\n \"admins\"\n ],\n \"title\": \"consequat magna labore\",\n \"value\": \"user_access_manage\"\n }\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/permission-settings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"permission-settings"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/permission-settings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"permission-settings"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/permission-settings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"permission-settings"
],
"variable": [
{
"key": "team_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update permission setting for team",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_permission_settings\",\n \"attributes\": {\n \"value\": \"teams_manage\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/permission-settings/:action",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"permission-settings",
":action"
],
"variable": [
{
"key": "team_id",
"value": "pariatur consequat"
},
{
"key": "action",
"value": "pariatur consequat"
}
]
},
"description": "Update a team permission setting for a given team."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_permission_settings\",\n \"attributes\": {\n \"value\": \"teams_manage\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/permission-settings/:action",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"permission-settings",
":action"
],
"variable": [
{
"key": "team_id"
},
{
"key": "action"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"TeamPermission-aeadc05e-98a8-11ec-ac2c-da7ad0900001-edit\",\n \"type\": \"team_permission_settings\",\n \"attributes\": {\n \"action\": \"manage_membership\",\n \"editable\": false,\n \"options\": [\n \"user_access_manage\",\n \"admins\"\n ],\n \"title\": \"do non exercitation dolore\",\n \"value\": \"teams_manage\"\n }\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_permission_settings\",\n \"attributes\": {\n \"value\": \"teams_manage\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/permission-settings/:action",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"permission-settings",
":action"
],
"variable": [
{
"key": "team_id"
},
{
"key": "action"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_permission_settings\",\n \"attributes\": {\n \"value\": \"teams_manage\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/permission-settings/:action",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"permission-settings",
":action"
],
"variable": [
{
"key": "team_id"
},
{
"key": "action"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"team_permission_settings\",\n \"attributes\": {\n \"value\": \"teams_manage\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team/:team_id/permission-settings/:action",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team",
":team_id",
"permission-settings",
":action"
],
"variable": [
{
"key": "team_id"
},
{
"key": "action"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Usage Metering",
"item": [
{
"name": "Get billing dimension mapping for usage endpoints",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/billing_dimension_mapping?filter[month]=2009-09-16T14:43:51.288Z&filter[view]=active",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"billing_dimension_mapping"
],
"query": [
{
"key": "filter[month]",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, and for mappings beginning this month. Defaults to the current month."
},
{
"key": "filter[view]",
"value": "active",
"description": "String to specify whether to retrieve active billing dimension mappings for the contract or for all available mappings. Allowed views have the string `active` or `all`. Defaults to `active`."
}
]
},
"description": "Get a mapping of billing dimensions to the corresponding keys for the supported usage metering public API endpoints.\nMapping data is updated on a monthly cadence.\n\nThis endpoint is only accessible to [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/billing_dimension_mapping?filter[month]=2009-09-16T14:43:51.288Z&filter[view]=active",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"billing_dimension_mapping"
],
"query": [
{
"key": "filter[month]",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, and for mappings beginning this month. Defaults to the current month."
},
{
"key": "filter[view]",
"value": "active",
"description": "String to specify whether to retrieve active billing dimension mappings for the contract or for all available mappings. Allowed views have the string `active` or `all`. Defaults to `active`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"endpoints\": [\n {\n \"id\": \"api/v1/usage/billable-summary\",\n \"keys\": [\n \"apm_host_top99p\",\n \"apm_host_sum\"\n ],\n \"status\": \"NOT_FOUND\"\n },\n {\n \"id\": \"api/v1/usage/billable-summary\",\n \"keys\": [\n \"apm_host_top99p\",\n \"apm_host_sum\"\n ],\n \"status\": \"OK\"\n }\n ],\n \"in_app_label\": \"APM Hosts\",\n \"timestamp\": \"1952-01-24T15:58:34.402Z\"\n },\n \"id\": \"eu nostrud aliquip est ut\",\n \"type\": \"billing_dimensions\"\n },\n {\n \"attributes\": {\n \"endpoints\": [\n {\n \"id\": \"api/v1/usage/billable-summary\",\n \"keys\": [\n \"apm_host_top99p\",\n \"apm_host_sum\"\n ],\n \"status\": \"OK\"\n },\n {\n \"id\": \"api/v1/usage/billable-summary\",\n \"keys\": [\n \"apm_host_top99p\",\n \"apm_host_sum\"\n ],\n \"status\": \"NOT_FOUND\"\n }\n ],\n \"in_app_label\": \"APM Hosts\",\n \"timestamp\": \"2000-12-02T14:26:49.062Z\"\n },\n \"id\": \"in magna\",\n \"type\": \"billing_dimensions\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/billing_dimension_mapping?filter[month]=2009-09-16T14:43:51.288Z&filter[view]=active",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"billing_dimension_mapping"
],
"query": [
{
"key": "filter[month]",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, and for mappings beginning this month. Defaults to the current month."
},
{
"key": "filter[view]",
"value": "active",
"description": "String to specify whether to retrieve active billing dimension mappings for the contract or for all available mappings. Allowed views have the string `active` or `all`. Defaults to `active`."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden - User is not authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/billing_dimension_mapping?filter[month]=2009-09-16T14:43:51.288Z&filter[view]=active",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"billing_dimension_mapping"
],
"query": [
{
"key": "filter[month]",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, and for mappings beginning this month. Defaults to the current month."
},
{
"key": "filter[view]",
"value": "active",
"description": "String to specify whether to retrieve active billing dimension mappings for the contract or for all available mappings. Allowed views have the string `active` or `all`. Defaults to `active`."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/billing_dimension_mapping?filter[month]=2009-09-16T14:43:51.288Z&filter[view]=active",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"billing_dimension_mapping"
],
"query": [
{
"key": "filter[month]",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, and for mappings beginning this month. Defaults to the current month."
},
{
"key": "filter[view]",
"value": "active",
"description": "String to specify whether to retrieve active billing dimension mappings for the contract or for all available mappings. Allowed views have the string `active` or `all`. Defaults to `active`."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get hourly usage by product family",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/hourly_usage?filter[timestamp][start]=2009-09-16T14:43:51.288Z&filter[timestamp][end]=2009-09-16T14:43:51.288Z&filter[product_families]=consectetur consequat dolor&filter[include_descendants]=false&filter[include_connected_accounts]=false&filter[include_breakdown]=false&filter[versions]=consectetur consequat dolor&page[limit]=500&page[next_record_id]=consectetur consequat dolor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"hourly_usage"
],
"query": [
{
"key": "filter[timestamp][start]",
"value": "2009-09-16T14:43:51.288Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
},
{
"key": "filter[timestamp][end]",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
},
{
"key": "filter[product_families]",
"value": "consectetur consequat dolor",
"description": "(Required) Comma separated list of product families to retrieve. Available families are `all`, `analyzed_logs`,\n`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`, `cloud_siem`,\n`csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`, `cws`, `dbm`, `error_tracking`,\n`fargate`, `infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`, `iot`,\n`lambda_traced_invocations`, `llm_observability`, `logs`, `network_flows`, `network_hosts`, `network_monitoring`,\n`observability_pipelines`, `online_archive`, `profiling`, `product_analytics`, `rum`, `rum_browser_sessions`,\n`rum_mobile_sessions`, `sds`, `snmp`, `software_delivery`, `synthetics_api`, `synthetics_browser`,\n`synthetics_mobile`, `synthetics_parallel_testing`, `timeseries`, `vuln_management` and `workflow_executions`.\nThe following product family has been **deprecated**: `audit_logs`."
},
{
"key": "filter[include_descendants]",
"value": "false",
"description": "Include child org usage in the response. Defaults to false."
},
{
"key": "filter[include_connected_accounts]",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to false."
},
{
"key": "filter[include_breakdown]",
"value": "false",
"description": "Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false."
},
{
"key": "filter[versions]",
"value": "consectetur consequat dolor",
"description": "Comma separated list of product family versions to use in the format `product_family:version`. For example,\n`infra_hosts:1.0.0`. If this parameter is not used, the API will use the latest version of each requested\nproduct family. Currently all families have one version `1.0.0`."
},
{
"key": "page[limit]",
"value": "500",
"description": "Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified."
},
{
"key": "page[next_record_id]",
"value": "consectetur consequat dolor",
"description": "List following results with a next_record_id provided in the previous query."
}
]
},
"description": "Get hourly usage by product family."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/hourly_usage?filter[timestamp][start]=2009-09-16T14:43:51.288Z&filter[timestamp][end]=2009-09-16T14:43:51.288Z&filter[product_families]=consectetur consequat dolor&filter[include_descendants]=false&filter[include_connected_accounts]=false&filter[include_breakdown]=false&filter[versions]=consectetur consequat dolor&page[limit]=500&page[next_record_id]=consectetur consequat dolor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"hourly_usage"
],
"query": [
{
"key": "filter[timestamp][start]",
"value": "2009-09-16T14:43:51.288Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
},
{
"key": "filter[timestamp][end]",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
},
{
"key": "filter[product_families]",
"value": "consectetur consequat dolor",
"description": "(Required) Comma separated list of product families to retrieve. Available families are `all`, `analyzed_logs`,\n`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`, `cloud_siem`,\n`csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`, `cws`, `dbm`, `error_tracking`,\n`fargate`, `infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`, `iot`,\n`lambda_traced_invocations`, `llm_observability`, `logs`, `network_flows`, `network_hosts`, `network_monitoring`,\n`observability_pipelines`, `online_archive`, `profiling`, `product_analytics`, `rum`, `rum_browser_sessions`,\n`rum_mobile_sessions`, `sds`, `snmp`, `software_delivery`, `synthetics_api`, `synthetics_browser`,\n`synthetics_mobile`, `synthetics_parallel_testing`, `timeseries`, `vuln_management` and `workflow_executions`.\nThe following product family has been **deprecated**: `audit_logs`."
},
{
"key": "filter[include_descendants]",
"value": "false",
"description": "Include child org usage in the response. Defaults to false."
},
{
"key": "filter[include_connected_accounts]",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to false."
},
{
"key": "filter[include_breakdown]",
"value": "false",
"description": "Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false."
},
{
"key": "filter[versions]",
"value": "consectetur consequat dolor",
"description": "Comma separated list of product family versions to use in the format `product_family:version`. For example,\n`infra_hosts:1.0.0`. If this parameter is not used, the API will use the latest version of each requested\nproduct family. Currently all families have one version `1.0.0`."
},
{
"key": "page[limit]",
"value": "500",
"description": "Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified."
},
{
"key": "page[next_record_id]",
"value": "consectetur consequat dolor",
"description": "List following results with a next_record_id provided in the previous query."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"account_name\": \"occaecat anim incididunt\",\n \"account_public_id\": \"occaecat tem\",\n \"measurements\": [\n {\n \"usage_type\": \"esse deserunt\",\n \"value\": -43852258\n },\n {\n \"usage_type\": \"esse ni\",\n \"value\": 16773289\n }\n ],\n \"org_name\": \"mollit Duis ut anim aliquip\",\n \"product_family\": \"non sunt\",\n \"public_id\": \"labore et ut\",\n \"region\": \"id dolore\",\n \"timestamp\": \"1999-12-02T13:53:02.035Z\"\n },\n \"id\": \"sunt minim veniam Lorem\",\n \"type\": \"usage_timeseries\"\n },\n {\n \"attributes\": {\n \"account_name\": \"laborum ad\",\n \"account_public_id\": \"in laboris esse\",\n \"measurements\": [\n {\n \"usage_type\": \"ipsum sint\",\n \"value\": 49499390\n },\n {\n \"usage_type\": \"ut sunt\",\n \"value\": 31502992\n }\n ],\n \"org_name\": \"id ut esse Ut\",\n \"product_family\": \"adipisicing\",\n \"public_id\": \"Ut elit\",\n \"region\": \"pariatur dolore nulla et\",\n \"timestamp\": \"1972-03-07T18:21:05.378Z\"\n },\n \"id\": \"magna incididunt minim adipisicing\",\n \"type\": \"usage_timeseries\"\n }\n ],\n \"meta\": {\n \"pagination\": {\n \"next_record_id\": \"et do\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/hourly_usage?filter[timestamp][start]=2009-09-16T14:43:51.288Z&filter[timestamp][end]=2009-09-16T14:43:51.288Z&filter[product_families]=consectetur consequat dolor&filter[include_descendants]=false&filter[include_connected_accounts]=false&filter[include_breakdown]=false&filter[versions]=consectetur consequat dolor&page[limit]=500&page[next_record_id]=consectetur consequat dolor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"hourly_usage"
],
"query": [
{
"key": "filter[timestamp][start]",
"value": "2009-09-16T14:43:51.288Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
},
{
"key": "filter[timestamp][end]",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
},
{
"key": "filter[product_families]",
"value": "consectetur consequat dolor",
"description": "(Required) Comma separated list of product families to retrieve. Available families are `all`, `analyzed_logs`,\n`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`, `cloud_siem`,\n`csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`, `cws`, `dbm`, `error_tracking`,\n`fargate`, `infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`, `iot`,\n`lambda_traced_invocations`, `llm_observability`, `logs`, `network_flows`, `network_hosts`, `network_monitoring`,\n`observability_pipelines`, `online_archive`, `profiling`, `product_analytics`, `rum`, `rum_browser_sessions`,\n`rum_mobile_sessions`, `sds`, `snmp`, `software_delivery`, `synthetics_api`, `synthetics_browser`,\n`synthetics_mobile`, `synthetics_parallel_testing`, `timeseries`, `vuln_management` and `workflow_executions`.\nThe following product family has been **deprecated**: `audit_logs`."
},
{
"key": "filter[include_descendants]",
"value": "false",
"description": "Include child org usage in the response. Defaults to false."
},
{
"key": "filter[include_connected_accounts]",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to false."
},
{
"key": "filter[include_breakdown]",
"value": "false",
"description": "Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false."
},
{
"key": "filter[versions]",
"value": "consectetur consequat dolor",
"description": "Comma separated list of product family versions to use in the format `product_family:version`. For example,\n`infra_hosts:1.0.0`. If this parameter is not used, the API will use the latest version of each requested\nproduct family. Currently all families have one version `1.0.0`."
},
{
"key": "page[limit]",
"value": "500",
"description": "Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified."
},
{
"key": "page[next_record_id]",
"value": "consectetur consequat dolor",
"description": "List following results with a next_record_id provided in the previous query."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden - User is not authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/hourly_usage?filter[timestamp][start]=2009-09-16T14:43:51.288Z&filter[timestamp][end]=2009-09-16T14:43:51.288Z&filter[product_families]=consectetur consequat dolor&filter[include_descendants]=false&filter[include_connected_accounts]=false&filter[include_breakdown]=false&filter[versions]=consectetur consequat dolor&page[limit]=500&page[next_record_id]=consectetur consequat dolor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"hourly_usage"
],
"query": [
{
"key": "filter[timestamp][start]",
"value": "2009-09-16T14:43:51.288Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
},
{
"key": "filter[timestamp][end]",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
},
{
"key": "filter[product_families]",
"value": "consectetur consequat dolor",
"description": "(Required) Comma separated list of product families to retrieve. Available families are `all`, `analyzed_logs`,\n`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`, `cloud_siem`,\n`csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`, `cws`, `dbm`, `error_tracking`,\n`fargate`, `infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`, `iot`,\n`lambda_traced_invocations`, `llm_observability`, `logs`, `network_flows`, `network_hosts`, `network_monitoring`,\n`observability_pipelines`, `online_archive`, `profiling`, `product_analytics`, `rum`, `rum_browser_sessions`,\n`rum_mobile_sessions`, `sds`, `snmp`, `software_delivery`, `synthetics_api`, `synthetics_browser`,\n`synthetics_mobile`, `synthetics_parallel_testing`, `timeseries`, `vuln_management` and `workflow_executions`.\nThe following product family has been **deprecated**: `audit_logs`."
},
{
"key": "filter[include_descendants]",
"value": "false",
"description": "Include child org usage in the response. Defaults to false."
},
{
"key": "filter[include_connected_accounts]",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to false."
},
{
"key": "filter[include_breakdown]",
"value": "false",
"description": "Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false."
},
{
"key": "filter[versions]",
"value": "consectetur consequat dolor",
"description": "Comma separated list of product family versions to use in the format `product_family:version`. For example,\n`infra_hosts:1.0.0`. If this parameter is not used, the API will use the latest version of each requested\nproduct family. Currently all families have one version `1.0.0`."
},
{
"key": "page[limit]",
"value": "500",
"description": "Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified."
},
{
"key": "page[next_record_id]",
"value": "consectetur consequat dolor",
"description": "List following results with a next_record_id provided in the previous query."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/hourly_usage?filter[timestamp][start]=2009-09-16T14:43:51.288Z&filter[timestamp][end]=2009-09-16T14:43:51.288Z&filter[product_families]=consectetur consequat dolor&filter[include_descendants]=false&filter[include_connected_accounts]=false&filter[include_breakdown]=false&filter[versions]=consectetur consequat dolor&page[limit]=500&page[next_record_id]=consectetur consequat dolor",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"hourly_usage"
],
"query": [
{
"key": "filter[timestamp][start]",
"value": "2009-09-16T14:43:51.288Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
},
{
"key": "filter[timestamp][end]",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
},
{
"key": "filter[product_families]",
"value": "consectetur consequat dolor",
"description": "(Required) Comma separated list of product families to retrieve. Available families are `all`, `analyzed_logs`,\n`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`, `cloud_siem`,\n`csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`, `cws`, `dbm`, `error_tracking`,\n`fargate`, `infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`, `iot`,\n`lambda_traced_invocations`, `llm_observability`, `logs`, `network_flows`, `network_hosts`, `network_monitoring`,\n`observability_pipelines`, `online_archive`, `profiling`, `product_analytics`, `rum`, `rum_browser_sessions`,\n`rum_mobile_sessions`, `sds`, `snmp`, `software_delivery`, `synthetics_api`, `synthetics_browser`,\n`synthetics_mobile`, `synthetics_parallel_testing`, `timeseries`, `vuln_management` and `workflow_executions`.\nThe following product family has been **deprecated**: `audit_logs`."
},
{
"key": "filter[include_descendants]",
"value": "false",
"description": "Include child org usage in the response. Defaults to false."
},
{
"key": "filter[include_connected_accounts]",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to false."
},
{
"key": "filter[include_breakdown]",
"value": "false",
"description": "Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false."
},
{
"key": "filter[versions]",
"value": "consectetur consequat dolor",
"description": "Comma separated list of product family versions to use in the format `product_family:version`. For example,\n`infra_hosts:1.0.0`. If this parameter is not used, the API will use the latest version of each requested\nproduct family. Currently all families have one version `1.0.0`."
},
{
"key": "page[limit]",
"value": "500",
"description": "Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified."
},
{
"key": "page[next_record_id]",
"value": "consectetur consequat dolor",
"description": "List following results with a next_record_id provided in the previous query."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get hourly usage attribution",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/hourly-attribution?start_hr=1993-10-23T16:56:47.315Z&end_hr=1993-10-23T16:56:47.315Z&usage_type=lambda_traced_invocations_usage&next_record_id=fugiat id&tag_breakdown_keys=fugiat id&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"hourly-attribution"
],
"query": [
{
"key": "start_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour."
},
{
"key": "usage_type",
"value": "lambda_traced_invocations_usage",
"description": "(Required) Usage type to retrieve. The following values have been **deprecated**:\n`estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`."
},
{
"key": "next_record_id",
"value": "fugiat id",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "tag_breakdown_keys",
"value": "fugiat id",
"description": "Comma separated list of tags used to group usage. If no value is provided the usage will not be broken down by tags.\n\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org usage in the response. Defaults to `true`."
}
]
},
"description": "Get hourly usage attribution. Multi-region data is available starting March 1, 2023.\n\nThis API endpoint is paginated. To make sure you receive all records, check if the value of `next_record_id` is\nset in the response. If it is, make another request and pass `next_record_id` as a parameter.\nPseudo code example:\n\n```\nresponse := GetHourlyUsageAttribution(start_month)\ncursor := response.metadata.pagination.next_record_id\nWHILE cursor != null BEGIN\n sleep(5 seconds) # Avoid running into rate limit\n response := GetHourlyUsageAttribution(start_month, next_record_id=cursor)\n cursor := response.metadata.pagination.next_record_id\nEND\n```"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/hourly-attribution?start_hr=1993-10-23T16:56:47.315Z&end_hr=1993-10-23T16:56:47.315Z&usage_type=lambda_traced_invocations_usage&next_record_id=fugiat id&tag_breakdown_keys=fugiat id&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"hourly-attribution"
],
"query": [
{
"key": "start_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour."
},
{
"key": "usage_type",
"value": "lambda_traced_invocations_usage",
"description": "(Required) Usage type to retrieve. The following values have been **deprecated**:\n`estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`."
},
{
"key": "next_record_id",
"value": "fugiat id",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "tag_breakdown_keys",
"value": "fugiat id",
"description": "Comma separated list of tags used to group usage. If no value is provided the usage will not be broken down by tags.\n\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org usage in the response. Defaults to `true`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"metadata\": {\n \"pagination\": {\n \"next_record_id\": \"cillum nostrud in\"\n }\n },\n \"usage\": [\n {\n \"hour\": \"2000-08-08T03:49:17.535Z\",\n \"org_name\": \"qui in incididunt officia\",\n \"public_id\": \"reprehenderit\",\n \"region\": \"labore sed enim officia\",\n \"tag_config_source\": \"proident fugiat ullamco ea\",\n \"tags\": {\n \"utd62\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ],\n \"do_21c\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ],\n \"ea_99b\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ]\n },\n \"total_usage_sum\": -85088115.80509397,\n \"updated_at\": \"dolor sunt\",\n \"usage_type\": \"infra_host_usage\"\n },\n {\n \"hour\": \"1964-07-23T17:22:18.853Z\",\n \"org_name\": \"proident eiusmod Excepteur quis\",\n \"public_id\": \"adipisicing\",\n \"region\": \"aliquip sint esse\",\n \"tag_config_source\": \"ex Duis\",\n \"tags\": {\n \"deserunt_f44\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ]\n },\n \"total_usage_sum\": 89413614.42650738,\n \"updated_at\": \"esse deserunt aliqua occaecat\",\n \"usage_type\": \"vuln_management_hosts_usage\"\n }\n ]\n}"
},
{
"name": "Forbidden - User is not authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/hourly-attribution?start_hr=1993-10-23T16:56:47.315Z&end_hr=1993-10-23T16:56:47.315Z&usage_type=lambda_traced_invocations_usage&next_record_id=fugiat id&tag_breakdown_keys=fugiat id&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"hourly-attribution"
],
"query": [
{
"key": "start_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour."
},
{
"key": "usage_type",
"value": "lambda_traced_invocations_usage",
"description": "(Required) Usage type to retrieve. The following values have been **deprecated**:\n`estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`."
},
{
"key": "next_record_id",
"value": "fugiat id",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "tag_breakdown_keys",
"value": "fugiat id",
"description": "Comma separated list of tags used to group usage. If no value is provided the usage will not be broken down by tags.\n\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org usage in the response. Defaults to `true`."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/hourly-attribution?start_hr=1993-10-23T16:56:47.315Z&end_hr=1993-10-23T16:56:47.315Z&usage_type=lambda_traced_invocations_usage&next_record_id=fugiat id&tag_breakdown_keys=fugiat id&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"hourly-attribution"
],
"query": [
{
"key": "start_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour."
},
{
"key": "usage_type",
"value": "lambda_traced_invocations_usage",
"description": "(Required) Usage type to retrieve. The following values have been **deprecated**:\n`estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`."
},
{
"key": "next_record_id",
"value": "fugiat id",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "tag_breakdown_keys",
"value": "fugiat id",
"description": "Comma separated list of tags used to group usage. If no value is provided the usage will not be broken down by tags.\n\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org usage in the response. Defaults to `true`."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get monthly usage attribution",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/monthly-attribution?start_month=1993-10-23T16:56:47.315Z&end_month=1993-10-23T16:56:47.315Z&fields=rum_session_replay_add_on_percentage&sort_direction=desc&sort_name=rum_session_replay_add_on_percentage&tag_breakdown_keys=fugiat id&next_record_id=fugiat id&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"monthly-attribution"
],
"query": [
{
"key": "start_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month.\nMaximum of 15 months ago."
},
{
"key": "end_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month."
},
{
"key": "fields",
"value": "rum_session_replay_add_on_percentage",
"description": "(Required) Comma-separated list of usage types to return, or `*` for all usage types.\nThe following values have been **deprecated**:\n`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`."
},
{
"key": "sort_direction",
"value": "desc",
"description": "The direction to sort by: `[desc, asc]`."
},
{
"key": "sort_name",
"value": "rum_session_replay_add_on_percentage",
"description": "The field to sort by.\nThe following values have been **deprecated**:\n`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`."
},
{
"key": "tag_breakdown_keys",
"value": "fugiat id",
"description": "Comma separated list of tag keys used to group usage. If no value is provided the usage will not be broken down by tags.\n\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "next_record_id",
"value": "fugiat id",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org usage in the response. Defaults to `true`."
}
]
},
"description": "Get monthly usage attribution. Multi-region data is available starting March 1, 2023.\n\nThis API endpoint is paginated. To make sure you receive all records, check if the value of `next_record_id` is\nset in the response. If it is, make another request and pass `next_record_id` as a parameter.\nPseudo code example:\n\n```\nresponse := GetMonthlyUsageAttribution(start_month)\ncursor := response.metadata.pagination.next_record_id\nWHILE cursor != null BEGIN\n sleep(5 seconds) # Avoid running into rate limit\n response := GetMonthlyUsageAttribution(start_month, next_record_id=cursor)\n cursor := response.metadata.pagination.next_record_id\nEND\n```"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/monthly-attribution?start_month=1993-10-23T16:56:47.315Z&end_month=1993-10-23T16:56:47.315Z&fields=rum_session_replay_add_on_percentage&sort_direction=desc&sort_name=rum_session_replay_add_on_percentage&tag_breakdown_keys=fugiat id&next_record_id=fugiat id&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"monthly-attribution"
],
"query": [
{
"key": "start_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month.\nMaximum of 15 months ago."
},
{
"key": "end_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month."
},
{
"key": "fields",
"value": "rum_session_replay_add_on_percentage",
"description": "(Required) Comma-separated list of usage types to return, or `*` for all usage types.\nThe following values have been **deprecated**:\n`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`."
},
{
"key": "sort_direction",
"value": "desc",
"description": "The direction to sort by: `[desc, asc]`."
},
{
"key": "sort_name",
"value": "rum_session_replay_add_on_percentage",
"description": "The field to sort by.\nThe following values have been **deprecated**:\n`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`."
},
{
"key": "tag_breakdown_keys",
"value": "fugiat id",
"description": "Comma separated list of tag keys used to group usage. If no value is provided the usage will not be broken down by tags.\n\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "next_record_id",
"value": "fugiat id",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org usage in the response. Defaults to `true`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"metadata\": {\n \"aggregates\": [\n {\n \"agg_type\": \"sum\",\n \"field\": \"custom_timeseries_usage\",\n \"value\": -91473434.81623827\n },\n {\n \"agg_type\": \"sum\",\n \"field\": \"custom_timeseries_usage\",\n \"value\": 18854297.80973722\n }\n ],\n \"pagination\": {\n \"next_record_id\": \"exercitation fugiat in sed\"\n }\n },\n \"usage\": [\n {\n \"month\": \"1959-12-04T12:35:42.164Z\",\n \"org_name\": \"tempor Duis laborum esse\",\n \"public_id\": \"adipisicing in\",\n \"region\": \"eu in\",\n \"tag_config_source\": \"voluptate\",\n \"tags\": {\n \"et_2d5\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ],\n \"utc0b\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ]\n },\n \"updated_at\": \"1954-08-28T19:54:19.964Z\",\n \"values\": {\n \"api_percentage\": -74846975.49962717,\n \"api_usage\": 99227714.01156268,\n \"apm_fargate_percentage\": 1115984.6013904363,\n \"apm_fargate_usage\": -34627405.42590963,\n \"apm_host_percentage\": 48690772.77494407,\n \"apm_host_usage\": 65394499.63315913,\n \"apm_usm_percentage\": 58271935.5711503,\n \"apm_usm_usage\": -90868228.27645451,\n \"appsec_fargate_percentage\": 432212.96691805124,\n \"appsec_fargate_usage\": -21882535.42617768,\n \"appsec_percentage\": 2909625.7821059376,\n \"appsec_usage\": 6702391.524678126,\n \"asm_serverless_traced_invocations_percentage\": -18712838.524518877,\n \"asm_serverless_traced_invocations_usage\": -68960634.31294417,\n \"browser_percentage\": -20818163.93914877,\n \"browser_usage\": 62361578.98022029,\n \"ci_pipeline_indexed_spans_percentage\": 17321413.738904893,\n \"ci_pipeline_indexed_spans_usage\": -87729484.12021437,\n \"ci_test_indexed_spans_percentage\": 20979190.252053946,\n \"ci_test_indexed_spans_usage\": -36743808.190965235,\n \"ci_visibility_itr_percentage\": 39716296.56232983,\n \"ci_visibility_itr_usage\": -78856575.11838682,\n \"cloud_siem_percentage\": -9158560.819169015,\n \"cloud_siem_usage\": 6092940.206056178,\n \"code_security_host_percentage\": -90287528.15867746,\n \"code_security_host_usage\": 32565262.532863364,\n \"container_excl_agent_percentage\": 99677517.59651926,\n \"container_excl_agent_usage\": -40937891.913598046,\n \"container_percentage\": 68692065.56413555,\n \"container_usage\": -52040049.76616834,\n \"cspm_containers_percentage\": -79388143.0647891,\n \"cspm_containers_usage\": 15252536.395234406,\n \"cspm_hosts_percentage\": -94915348.37790161,\n \"cspm_hosts_usage\": 59938764.40526545,\n \"custom_event_percentage\": 17403471.653704107,\n \"custom_event_usage\": 12914457.851369336,\n \"custom_ingested_timeseries_percentage\": -74818850.42839296,\n \"custom_ingested_timeseries_usage\": -69572703.69011119,\n \"custom_timeseries_percentage\": 22751207.87433675,\n \"custom_timeseries_usage\": -75921016.6712857,\n \"cws_containers_percentage\": -39087482.519304626,\n \"cws_containers_usage\": 94614112.38806057,\n \"cws_fargate_task_percentage\": 83811377.55661449,\n \"cws_fargate_task_usage\": 33069155.142363697,\n \"cws_hosts_percentage\": -66549727.47153258,\n \"cws_hosts_usage\": 39315410.05320561,\n \"data_jobs_monitoring_usage\": -8062138.867349699,\n \"data_stream_monitoring_usage\": -83412990.17360781,\n \"dbm_hosts_percentage\": 48342714.87034598,\n \"dbm_hosts_usage\": -87884207.61064275,\n \"dbm_queries_percentage\": 71638685.46592364,\n \"dbm_queries_usage\": 83275801.69403628,\n \"error_tracking_percentage\": 29440102.312949866,\n \"error_tracking_usage\": -49894293.040222816,\n \"estimated_indexed_spans_percentage\": -5439571.245803624,\n \"estimated_indexed_spans_usage\": 98279767.62984681,\n \"estimated_ingested_spans_percentage\": -56684670.11507181,\n \"estimated_ingested_spans_usage\": -52595520.703099206,\n \"fargate_percentage\": 89755536.00185436,\n \"fargate_usage\": -26608341.612179756,\n \"functions_percentage\": 94939953.20007798,\n \"functions_usage\": -61423414.92284566,\n \"incident_management_monthly_active_users_percentage\": 46561161.50677475,\n \"incident_management_monthly_active_users_usage\": 39784851.82099387,\n \"indexed_spans_percentage\": 31344113.741531193,\n \"indexed_spans_usage\": 10629460.232089743,\n \"infra_host_percentage\": 32204119.597774923,\n \"infra_host_usage\": 79934377.41758317,\n \"ingested_logs_bytes_percentage\": -85877646.96968055,\n \"ingested_logs_bytes_usage\": 7683047.049517989,\n \"ingested_spans_bytes_percentage\": -42700875.543540694,\n \"ingested_spans_bytes_usage\": 10872550.211713985,\n \"invocations_percentage\": -67563175.40013692,\n \"invocations_usage\": 54893363.56543276,\n \"lambda_traced_invocations_percentage\": -1814321.638364613,\n \"lambda_traced_invocations_usage\": -21896799.270020857,\n \"llm_observability_percentage\": 94532075.8893682,\n \"llm_observability_usage\": 16532738.773770332,\n \"logs_indexed_15day_percentage\": -56012004.31920699,\n \"logs_indexed_15day_usage\": -94941512.05063578,\n \"logs_indexed_180day_percentage\": -41181007.91220054,\n \"logs_indexed_180day_usage\": -93744279.31638247,\n \"logs_indexed_1day_percentage\": 36820013.102400154,\n \"logs_indexed_1day_usage\": -63091506.05061031,\n \"logs_indexed_30day_percentage\": -18174109.549303934,\n \"logs_indexed_30day_usage\": -55769809.0194992,\n \"logs_indexed_360day_percentage\": -52525544.551645644,\n \"logs_indexed_360day_usage\": 11808956.469637424,\n \"logs_indexed_3day_percentage\": 83494634.078415,\n \"logs_indexed_3day_usage\": -62874246.18070608,\n \"logs_indexed_45day_percentage\": -75605232.13647239,\n \"logs_indexed_45day_usage\": -97696239.42998844,\n \"logs_indexed_60day_percentage\": -78938439.02066666,\n \"logs_indexed_60day_usage\": 67602008.59431335,\n \"logs_indexed_7day_percentage\": 72059962.72637814,\n \"logs_indexed_7day_usage\": -52423372.93031258,\n \"logs_indexed_90day_percentage\": 38041654.649272084,\n \"logs_indexed_90day_usage\": 98978465.89352795,\n \"logs_indexed_custom_retention_percentage\": -81914086.42415719,\n \"logs_indexed_custom_retention_usage\": -50665837.8940726,\n \"mobile_app_testing_percentage\": -98626561.90287413,\n \"mobile_app_testing_usage\": -38340728.818883374,\n \"ndm_netflow_percentage\": 41328831.26113534,\n \"ndm_netflow_usage\": 19477948.06367506,\n \"network_device_wireless_percentage\": 58589006.01644489,\n \"network_device_wireless_usage\": 87377968.66061491,\n \"npm_host_percentage\": -1822509.7916437536,\n \"npm_host_usage\": 90003175.11682051,\n \"obs_pipeline_bytes_percentage\": -63831059.79233308,\n \"obs_pipeline_bytes_usage\": -98229222.99198633,\n \"obs_pipelines_vcpu_percentage\": -16475720.194933772,\n \"obs_pipelines_vcpu_usage\": -12889375.889242023,\n \"online_archive_percentage\": 74703113.13809177,\n \"online_archive_usage\": 74736652.4368951,\n \"product_analytics_session_percentage\": -11603000.894346625,\n \"product_analytics_session_usage\": -45199503.90155434,\n \"profiled_container_percentage\": -62752603.26722865,\n \"profiled_container_usage\": -13080036.028896809,\n \"profiled_fargate_percentage\": 89399266.57330555,\n \"profiled_fargate_usage\": 31507433.253816262,\n \"profiled_host_percentage\": 3400555.038387254,\n \"profiled_host_usage\": -86983894.01977962,\n \"published_app_percentage\": 94401610.22476646,\n \"published_app_usage\": 5549729.440423861,\n \"rum_browser_mobile_sessions_percentage\": 19688961.40245107,\n \"rum_browser_mobile_sessions_usage\": 12378468.645828515,\n \"rum_ingested_percentage\": 10327213.594027683,\n \"rum_ingested_usage\": -22848631.98339522,\n \"rum_investigate_percentage\": 51541768.44469708,\n \"rum_investigate_usage\": -62912992.458249725,\n \"rum_replay_sessions_percentage\": -76728723.00888962,\n \"rum_replay_sessions_usage\": -12981743.388355985,\n \"rum_session_replay_add_on_percentage\": -53482544.10419482,\n \"rum_session_replay_add_on_usage\": 67868389.15789366,\n \"sca_fargate_percentage\": -37811633.95920651,\n \"sca_fargate_usage\": 40661200.75500968,\n \"sds_scanned_bytes_percentage\": -18441171.869026676,\n \"sds_scanned_bytes_usage\": -77406111.50515977,\n \"serverless_apps_percentage\": -38123643.422104836,\n \"serverless_apps_usage\": 22458706.69977787,\n \"siem_analyzed_logs_add_on_percentage\": -56858881.60766186,\n \"siem_analyzed_logs_add_on_usage\": 84975949.90855601,\n \"siem_ingested_bytes_percentage\": 50122564.21119562,\n \"siem_ingested_bytes_usage\": -79394003.24897605,\n \"snmp_percentage\": -68550729.74378552,\n \"snmp_usage\": -91022548.38946962,\n \"universal_service_monitoring_percentage\": 41663316.70429313,\n \"universal_service_monitoring_usage\": 30296456.857194155,\n \"vuln_management_hosts_percentage\": -79253036.00204995,\n \"vuln_management_hosts_usage\": -44344201.643477365,\n \"workflow_executions_percentage\": -56317599.003090724,\n \"workflow_executions_usage\": -54954450.99687131\n }\n },\n {\n \"month\": \"2004-01-03T02:12:14.210Z\",\n \"org_name\": \"deserunt nisi qui\",\n \"public_id\": \"amet sed\",\n \"region\": \"ea occaecat do\",\n \"tag_config_source\": \"voluptate dolore pariatur\",\n \"tags\": {\n \"magna_32_\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ],\n \"inf\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ],\n \"quisef\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ],\n \"nisi2_c\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ]\n },\n \"updated_at\": \"1977-06-29T03:22:36.261Z\",\n \"values\": {\n \"api_percentage\": 32164214.698953986,\n \"api_usage\": 91876636.53103402,\n \"apm_fargate_percentage\": -75491390.52576661,\n \"apm_fargate_usage\": -24487611.634539142,\n \"apm_host_percentage\": -73679410.64885564,\n \"apm_host_usage\": -98536272.39704987,\n \"apm_usm_percentage\": -82939236.35291101,\n \"apm_usm_usage\": -38540859.54510804,\n \"appsec_fargate_percentage\": 21182768.319703445,\n \"appsec_fargate_usage\": 1810491.8922971785,\n \"appsec_percentage\": 72398834.28834471,\n \"appsec_usage\": 59536799.339856416,\n \"asm_serverless_traced_invocations_percentage\": 76609977.68407628,\n \"asm_serverless_traced_invocations_usage\": -62868738.97072602,\n \"browser_percentage\": 22874710.763784885,\n \"browser_usage\": -37688153.47209724,\n \"ci_pipeline_indexed_spans_percentage\": -29807378.27890943,\n \"ci_pipeline_indexed_spans_usage\": 66222079.76272741,\n \"ci_test_indexed_spans_percentage\": -4509053.012138486,\n \"ci_test_indexed_spans_usage\": 29594390.396575496,\n \"ci_visibility_itr_percentage\": -30634747.688637614,\n \"ci_visibility_itr_usage\": 67616950.39058831,\n \"cloud_siem_percentage\": 64278715.299407065,\n \"cloud_siem_usage\": -21045855.191154227,\n \"code_security_host_percentage\": 52327608.79444677,\n \"code_security_host_usage\": -67734777.0516703,\n \"container_excl_agent_percentage\": -58105092.20680042,\n \"container_excl_agent_usage\": 43151810.77567008,\n \"container_percentage\": -1337225.1959024519,\n \"container_usage\": -22388547.399563268,\n \"cspm_containers_percentage\": 44812831.1506221,\n \"cspm_containers_usage\": 26570177.989411637,\n \"cspm_hosts_percentage\": -50975060.01427605,\n \"cspm_hosts_usage\": -41383767.63893448,\n \"custom_event_percentage\": -95386667.58161034,\n \"custom_event_usage\": 18787587.98039435,\n \"custom_ingested_timeseries_percentage\": 55973086.31335184,\n \"custom_ingested_timeseries_usage\": 60199857.776121944,\n \"custom_timeseries_percentage\": -51400517.48963159,\n \"custom_timeseries_usage\": 25908127.66768445,\n \"cws_containers_percentage\": 45325884.35463634,\n \"cws_containers_usage\": -78116809.00904459,\n \"cws_fargate_task_percentage\": -47634371.98820832,\n \"cws_fargate_task_usage\": -90061365.2010243,\n \"cws_hosts_percentage\": -76298394.80976215,\n \"cws_hosts_usage\": 53662314.68869048,\n \"data_jobs_monitoring_usage\": -49100964.64981726,\n \"data_stream_monitoring_usage\": -1850689.7502956092,\n \"dbm_hosts_percentage\": -43140317.90880586,\n \"dbm_hosts_usage\": 30800195.31207922,\n \"dbm_queries_percentage\": -72268159.60173331,\n \"dbm_queries_usage\": -83072663.98617375,\n \"error_tracking_percentage\": 45917421.50296879,\n \"error_tracking_usage\": -57539721.1146846,\n \"estimated_indexed_spans_percentage\": -64125560.99600919,\n \"estimated_indexed_spans_usage\": 68221240.03006637,\n \"estimated_ingested_spans_percentage\": -21998338.57759787,\n \"estimated_ingested_spans_usage\": 6193343.416638836,\n \"fargate_percentage\": -49109732.61917304,\n \"fargate_usage\": 46922828.4904283,\n \"functions_percentage\": -96362673.27396053,\n \"functions_usage\": 60956334.420513004,\n \"incident_management_monthly_active_users_percentage\": -48406588.1610779,\n \"incident_management_monthly_active_users_usage\": -44905893.59518642,\n \"indexed_spans_percentage\": -18055308.971186876,\n \"indexed_spans_usage\": 53580523.589286685,\n \"infra_host_percentage\": 66588910.56394377,\n \"infra_host_usage\": -85299865.30318683,\n \"ingested_logs_bytes_percentage\": -28900646.38719067,\n \"ingested_logs_bytes_usage\": 53466955.57630476,\n \"ingested_spans_bytes_percentage\": -69190653.40895428,\n \"ingested_spans_bytes_usage\": 72610195.71076554,\n \"invocations_percentage\": -46678773.79337142,\n \"invocations_usage\": -30043802.05171269,\n \"lambda_traced_invocations_percentage\": -81371269.47408047,\n \"lambda_traced_invocations_usage\": 31732861.539982513,\n \"llm_observability_percentage\": -20153283.705000475,\n \"llm_observability_usage\": 18016263.093640476,\n \"logs_indexed_15day_percentage\": 42130536.051401734,\n \"logs_indexed_15day_usage\": 71611972.776562,\n \"logs_indexed_180day_percentage\": -92980742.46144481,\n \"logs_indexed_180day_usage\": 89809427.9926514,\n \"logs_indexed_1day_percentage\": 91465181.72511539,\n \"logs_indexed_1day_usage\": -6978990.387529165,\n \"logs_indexed_30day_percentage\": -77011205.96689248,\n \"logs_indexed_30day_usage\": -49688785.597106785,\n \"logs_indexed_360day_percentage\": 88628407.43444833,\n \"logs_indexed_360day_usage\": -51183458.31263791,\n \"logs_indexed_3day_percentage\": -95789526.638078,\n \"logs_indexed_3day_usage\": 37568603.07250184,\n \"logs_indexed_45day_percentage\": -92286972.11159919,\n \"logs_indexed_45day_usage\": 78024660.61681977,\n \"logs_indexed_60day_percentage\": 72184289.818488,\n \"logs_indexed_60day_usage\": -21747704.569902137,\n \"logs_indexed_7day_percentage\": -29694692.073381558,\n \"logs_indexed_7day_usage\": 64780556.756658286,\n \"logs_indexed_90day_percentage\": 90380792.86700594,\n \"logs_indexed_90day_usage\": -4410718.327588439,\n \"logs_indexed_custom_retention_percentage\": 13548218.394306973,\n \"logs_indexed_custom_retention_usage\": 15904674.712497368,\n \"mobile_app_testing_percentage\": 2808042.974497631,\n \"mobile_app_testing_usage\": 48384476.14265245,\n \"ndm_netflow_percentage\": -99967509.70075177,\n \"ndm_netflow_usage\": -56953131.94136762,\n \"network_device_wireless_percentage\": 63537944.610524446,\n \"network_device_wireless_usage\": 78487832.57823965,\n \"npm_host_percentage\": -39055360.60444123,\n \"npm_host_usage\": 65338543.799783975,\n \"obs_pipeline_bytes_percentage\": 7612140.463995025,\n \"obs_pipeline_bytes_usage\": -45935219.87086897,\n \"obs_pipelines_vcpu_percentage\": 68592430.7113078,\n \"obs_pipelines_vcpu_usage\": -44296152.9120625,\n \"online_archive_percentage\": -86155292.2780428,\n \"online_archive_usage\": 21227538.218849704,\n \"product_analytics_session_percentage\": -78042251.4376371,\n \"product_analytics_session_usage\": 76142031.54793623,\n \"profiled_container_percentage\": 3054838.4842094034,\n \"profiled_container_usage\": 49678814.15816003,\n \"profiled_fargate_percentage\": 25161829.23999837,\n \"profiled_fargate_usage\": -44705329.02184976,\n \"profiled_host_percentage\": -18553237.30490756,\n \"profiled_host_usage\": 13771385.544388488,\n \"published_app_percentage\": 86358971.39797929,\n \"published_app_usage\": 7462299.012945309,\n \"rum_browser_mobile_sessions_percentage\": 938684.2801115066,\n \"rum_browser_mobile_sessions_usage\": 18584300.38340953,\n \"rum_ingested_percentage\": -39732818.176043436,\n \"rum_ingested_usage\": -41518415.57237506,\n \"rum_investigate_percentage\": -39009985.56569417,\n \"rum_investigate_usage\": 6998159.928432286,\n \"rum_replay_sessions_percentage\": -52571642.40283545,\n \"rum_replay_sessions_usage\": 6045558.531432465,\n \"rum_session_replay_add_on_percentage\": 69121142.62938192,\n \"rum_session_replay_add_on_usage\": -71591598.9849729,\n \"sca_fargate_percentage\": 34162486.71775213,\n \"sca_fargate_usage\": 74021766.79124701,\n \"sds_scanned_bytes_percentage\": -48847804.03771434,\n \"sds_scanned_bytes_usage\": 45546815.24537763,\n \"serverless_apps_percentage\": 22748925.170680344,\n \"serverless_apps_usage\": 17531412.102653816,\n \"siem_analyzed_logs_add_on_percentage\": 69013713.18534297,\n \"siem_analyzed_logs_add_on_usage\": -87890404.53448978,\n \"siem_ingested_bytes_percentage\": -44516702.57408244,\n \"siem_ingested_bytes_usage\": 51742158.857106894,\n \"snmp_percentage\": -37634969.60502115,\n \"snmp_usage\": -61858340.26716259,\n \"universal_service_monitoring_percentage\": 92556420.24038088,\n \"universal_service_monitoring_usage\": -23038520.69895816,\n \"vuln_management_hosts_percentage\": 83400388.84540454,\n \"vuln_management_hosts_usage\": -89583058.46481869,\n \"workflow_executions_percentage\": 18182444.210250035,\n \"workflow_executions_usage\": -63529945.21207967\n }\n }\n ]\n}"
},
{
"name": "Forbidden - User is not authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/monthly-attribution?start_month=1993-10-23T16:56:47.315Z&end_month=1993-10-23T16:56:47.315Z&fields=rum_session_replay_add_on_percentage&sort_direction=desc&sort_name=rum_session_replay_add_on_percentage&tag_breakdown_keys=fugiat id&next_record_id=fugiat id&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"monthly-attribution"
],
"query": [
{
"key": "start_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month.\nMaximum of 15 months ago."
},
{
"key": "end_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month."
},
{
"key": "fields",
"value": "rum_session_replay_add_on_percentage",
"description": "(Required) Comma-separated list of usage types to return, or `*` for all usage types.\nThe following values have been **deprecated**:\n`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`."
},
{
"key": "sort_direction",
"value": "desc",
"description": "The direction to sort by: `[desc, asc]`."
},
{
"key": "sort_name",
"value": "rum_session_replay_add_on_percentage",
"description": "The field to sort by.\nThe following values have been **deprecated**:\n`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`."
},
{
"key": "tag_breakdown_keys",
"value": "fugiat id",
"description": "Comma separated list of tag keys used to group usage. If no value is provided the usage will not be broken down by tags.\n\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "next_record_id",
"value": "fugiat id",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org usage in the response. Defaults to `true`."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/monthly-attribution?start_month=1993-10-23T16:56:47.315Z&end_month=1993-10-23T16:56:47.315Z&fields=rum_session_replay_add_on_percentage&sort_direction=desc&sort_name=rum_session_replay_add_on_percentage&tag_breakdown_keys=fugiat id&next_record_id=fugiat id&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"monthly-attribution"
],
"query": [
{
"key": "start_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month.\nMaximum of 15 months ago."
},
{
"key": "end_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month."
},
{
"key": "fields",
"value": "rum_session_replay_add_on_percentage",
"description": "(Required) Comma-separated list of usage types to return, or `*` for all usage types.\nThe following values have been **deprecated**:\n`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`."
},
{
"key": "sort_direction",
"value": "desc",
"description": "The direction to sort by: `[desc, asc]`."
},
{
"key": "sort_name",
"value": "rum_session_replay_add_on_percentage",
"description": "The field to sort by.\nThe following values have been **deprecated**:\n`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`."
},
{
"key": "tag_breakdown_keys",
"value": "fugiat id",
"description": "Comma separated list of tag keys used to group usage. If no value is provided the usage will not be broken down by tags.\n\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "next_record_id",
"value": "fugiat id",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org usage in the response. Defaults to `true`."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get active billing dimensions for cost attribution",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost_by_tag/active_billing_dimensions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost_by_tag",
"active_billing_dimensions"
]
},
"description": "Get active billing dimensions for cost attribution. Cost data for a given month becomes available no later than the 19th of the following month."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost_by_tag/active_billing_dimensions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost_by_tag",
"active_billing_dimensions"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"month\": \"1987-08-04T04:34:53.036Z\",\n \"values\": [\n \"infra_host\",\n \"infra_host\"\n ]\n },\n \"id\": \"commodo quis fugiat\",\n \"type\": \"billing_dimensions\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost_by_tag/active_billing_dimensions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost_by_tag",
"active_billing_dimensions"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden - User is not authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost_by_tag/active_billing_dimensions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost_by_tag",
"active_billing_dimensions"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost_by_tag/active_billing_dimensions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost_by_tag",
"active_billing_dimensions"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get billable usage across your account",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/billable-summary?month=1993-10-23T16:56:47.315Z&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"billable-summary"
],
"query": [
{
"key": "month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
},
"description": "Get billable usage across your account.\n\nThis endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/billable-summary?month=1993-10-23T16:56:47.315Z&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"billable-summary"
],
"query": [
{
"key": "month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"usage\": [\n {\n \"account_name\": \"ad proident tempor veniam cillum\",\n \"account_public_id\": \"enim cillum\",\n \"billing_plan\": \"aliqua\",\n \"end_date\": \"1997-11-08T02:13:06.100Z\",\n \"num_orgs\": -22922618,\n \"org_name\": \"culpa sunt et\",\n \"public_id\": \"aliquip \",\n \"ratio_in_month\": 77931097.79289573,\n \"region\": \"nulla proident deserunt\",\n \"start_date\": \"1999-10-23T07:43:31.638Z\",\n \"usage\": {\n \"apm_fargate_average\": {\n \"account_billable_usage\": -47666656,\n \"account_committed_usage\": 36276688,\n \"account_on_demand_usage\": -23228141,\n \"elapsed_usage_hours\": 86225896,\n \"first_billable_usage_hour\": \"1994-04-04T07:43:46.061Z\",\n \"last_billable_usage_hour\": \"1974-11-13T05:41:36.698Z\",\n \"org_billable_usage\": -49058968,\n \"percentage_in_account\": -18396519.483827278,\n \"usage_unit\": \"reprehenderit \"\n },\n \"apm_fargate_sum\": {\n \"account_billable_usage\": 37860195,\n \"account_committed_usage\": 40688486,\n \"account_on_demand_usage\": 87639963,\n \"elapsed_usage_hours\": -83412980,\n \"first_billable_usage_hour\": \"2011-07-31T12:43:33.016Z\",\n \"last_billable_usage_hour\": \"1983-01-31T17:51:09.459Z\",\n \"org_billable_usage\": -67543248,\n \"percentage_in_account\": 99236231.83063602,\n \"usage_unit\": \"amet veniam sunt\"\n },\n \"apm_host_sum\": {\n \"account_billable_usage\": -58635090,\n \"account_committed_usage\": -9256315,\n \"account_on_demand_usage\": -45276393,\n \"elapsed_usage_hours\": -52497293,\n \"first_billable_usage_hour\": \"2009-06-10T07:48:27.913Z\",\n \"last_billable_usage_hour\": \"1956-10-16T14:20:01.231Z\",\n \"org_billable_usage\": 87856726,\n \"percentage_in_account\": -64383108.24725695,\n \"usage_unit\": \"commodo Lorem eu quis\"\n },\n \"apm_host_top99p\": {\n \"account_billable_usage\": -34778168,\n \"account_committed_usage\": -64224401,\n \"account_on_demand_usage\": -64892046,\n \"elapsed_usage_hours\": 75947483,\n \"first_billable_usage_hour\": \"1949-03-01T17:54:30.939Z\",\n \"last_billable_usage_hour\": \"1968-08-22T12:10:48.360Z\",\n \"org_billable_usage\": -28878413,\n \"percentage_in_account\": 86426686.13614336,\n \"usage_unit\": \"Duis sit\"\n },\n \"apm_profiler_host_sum\": {\n \"account_billable_usage\": 39390908,\n \"account_committed_usage\": 82779287,\n \"account_on_demand_usage\": -62875077,\n \"elapsed_usage_hours\": 99366122,\n \"first_billable_usage_hour\": \"1982-03-24T16:18:11.555Z\",\n \"last_billable_usage_hour\": \"1965-11-20T16:27:22.457Z\",\n \"org_billable_usage\": -90096103,\n \"percentage_in_account\": -12728481.078653768,\n \"usage_unit\": \"cillum ut in\"\n },\n \"apm_profiler_host_top99p\": {\n \"account_billable_usage\": 87017536,\n \"account_committed_usage\": 86488036,\n \"account_on_demand_usage\": 39461936,\n \"elapsed_usage_hours\": -98695274,\n \"first_billable_usage_hour\": \"2015-12-02T14:45:38.921Z\",\n \"last_billable_usage_hour\": \"1950-01-06T10:54:51.298Z\",\n \"org_billable_usage\": -85304434,\n \"percentage_in_account\": 19798730.247066334,\n \"usage_unit\": \"dolore consequat enim\"\n },\n \"apm_trace_search_sum\": {\n \"account_billable_usage\": -57183455,\n \"account_committed_usage\": 69137781,\n \"account_on_demand_usage\": 80367425,\n \"elapsed_usage_hours\": 55216716,\n \"first_billable_usage_hour\": \"1946-05-19T15:44:50.820Z\",\n \"last_billable_usage_hour\": \"1974-10-05T17:58:27.531Z\",\n \"org_billable_usage\": 37344516,\n \"percentage_in_account\": -89265453.01057087,\n \"usage_unit\": \"ullamco \"\n },\n \"application_security_fargate_average\": {\n \"account_billable_usage\": -61139930,\n \"account_committed_usage\": 10968661,\n \"account_on_demand_usage\": -15116557,\n \"elapsed_usage_hours\": -90443040,\n \"first_billable_usage_hour\": \"1946-12-03T09:18:37.252Z\",\n \"last_billable_usage_hour\": \"1979-06-18T01:16:44.132Z\",\n \"org_billable_usage\": 57382257,\n \"percentage_in_account\": 63111887.50644219,\n \"usage_unit\": \"nostrud Duis \"\n },\n \"application_security_host_sum\": {\n \"account_billable_usage\": 17657429,\n \"account_committed_usage\": -7766091,\n \"account_on_demand_usage\": -54716133,\n \"elapsed_usage_hours\": -2096793,\n \"first_billable_usage_hour\": \"1993-08-13T16:09:03.131Z\",\n \"last_billable_usage_hour\": \"1994-09-17T00:19:20.727Z\",\n \"org_billable_usage\": 97378313,\n \"percentage_in_account\": 16736389.068501145,\n \"usage_unit\": \"reprehenderit eiusmod sit Duis\"\n },\n \"application_security_host_top99p\": {\n \"account_billable_usage\": 36526818,\n \"account_committed_usage\": 20976598,\n \"account_on_demand_usage\": -56861915,\n \"elapsed_usage_hours\": 84578815,\n \"first_billable_usage_hour\": \"1983-08-24T17:33:09.644Z\",\n \"last_billable_usage_hour\": \"1950-03-08T11:11:56.982Z\",\n \"org_billable_usage\": -96197648,\n \"percentage_in_account\": -95256001.951311,\n \"usage_unit\": \"ut et sint\"\n },\n \"ci_pipeline_indexed_spans_sum\": {\n \"account_billable_usage\": 29028929,\n \"account_committed_usage\": 51845515,\n \"account_on_demand_usage\": 19035652,\n \"elapsed_usage_hours\": 57373435,\n \"first_billable_usage_hour\": \"1961-12-07T18:47:17.109Z\",\n \"last_billable_usage_hour\": \"2018-07-23T03:33:43.513Z\",\n \"org_billable_usage\": -77490217,\n \"percentage_in_account\": 87335121.57062596,\n \"usage_unit\": \"occaecat ut nulla velit fugiat\"\n },\n \"ci_pipeline_maximum\": {\n \"account_billable_usage\": 74317429,\n \"account_committed_usage\": -90945329,\n \"account_on_demand_usage\": -97718339,\n \"elapsed_usage_hours\": -46808683,\n \"first_billable_usage_hour\": \"1966-02-24T02:20:45.382Z\",\n \"last_billable_usage_hour\": \"1996-04-02T05:14:38.496Z\",\n \"org_billable_usage\": -33951271,\n \"percentage_in_account\": 41779362.167277634,\n \"usage_unit\": \"aliqua esse mollit sed\"\n },\n \"ci_pipeline_sum\": {\n \"account_billable_usage\": -12593285,\n \"account_committed_usage\": -14592648,\n \"account_on_demand_usage\": -64264545,\n \"elapsed_usage_hours\": -8076314,\n \"first_billable_usage_hour\": \"1960-04-03T14:03:04.957Z\",\n \"last_billable_usage_hour\": \"1950-01-11T02:08:40.369Z\",\n \"org_billable_usage\": 15511629,\n \"percentage_in_account\": -51907796.4675007,\n \"usage_unit\": \"quis elit pariatur\"\n },\n \"ci_test_indexed_spans_sum\": {\n \"account_billable_usage\": -88169871,\n \"account_committed_usage\": 35316451,\n \"account_on_demand_usage\": 5950890,\n \"elapsed_usage_hours\": -90508585,\n \"first_billable_usage_hour\": \"2015-04-04T14:45:43.813Z\",\n \"last_billable_usage_hour\": \"2007-12-24T05:48:06.316Z\",\n \"org_billable_usage\": 17008304,\n \"percentage_in_account\": 43688242.93838096,\n \"usage_unit\": \"in enim\"\n },\n \"ci_testing_maximum\": {\n \"account_billable_usage\": -45011495,\n \"account_committed_usage\": 81278726,\n \"account_on_demand_usage\": -21231289,\n \"elapsed_usage_hours\": 20412830,\n \"first_billable_usage_hour\": \"1953-06-08T09:53:48.723Z\",\n \"last_billable_usage_hour\": \"1993-10-24T10:13:01.662Z\",\n \"org_billable_usage\": -53010739,\n \"percentage_in_account\": 79536432.92128065,\n \"usage_unit\": \"et sed sunt consectetur\"\n },\n \"ci_testing_sum\": {\n \"account_billable_usage\": -15606186,\n \"account_committed_usage\": 49599034,\n \"account_on_demand_usage\": 72577925,\n \"elapsed_usage_hours\": 55012978,\n \"first_billable_usage_hour\": \"1984-10-11T00:18:59.047Z\",\n \"last_billable_usage_hour\": \"1962-09-19T08:13:02.358Z\",\n \"org_billable_usage\": 41953757,\n \"percentage_in_account\": 44963372.182344764,\n \"usage_unit\": \"aliquip aliqua\"\n },\n \"cloud_cost_management_average\": {\n \"account_billable_usage\": 54462494,\n \"account_committed_usage\": 49176349,\n \"account_on_demand_usage\": 50894878,\n \"elapsed_usage_hours\": 13783387,\n \"first_billable_usage_hour\": \"1965-03-17T13:32:10.007Z\",\n \"last_billable_usage_hour\": \"1987-03-26T05:28:58.299Z\",\n \"org_billable_usage\": 7870885,\n \"percentage_in_account\": -61682830.19046581,\n \"usage_unit\": \"conse\"\n },\n \"cloud_cost_management_sum\": {\n \"account_billable_usage\": 38853946,\n \"account_committed_usage\": 85982732,\n \"account_on_demand_usage\": 62578653,\n \"elapsed_usage_hours\": 71825399,\n \"first_billable_usage_hour\": \"1980-11-24T13:33:04.286Z\",\n \"last_billable_usage_hour\": \"2007-02-07T18:49:16.840Z\",\n \"org_billable_usage\": -26279508,\n \"percentage_in_account\": -77018311.93803605,\n \"usage_unit\": \"Lorem\"\n },\n \"cspm_container_sum\": {\n \"account_billable_usage\": -81538565,\n \"account_committed_usage\": -85364194,\n \"account_on_demand_usage\": -3969390,\n \"elapsed_usage_hours\": -77917518,\n \"first_billable_usage_hour\": \"1978-11-19T09:32:38.876Z\",\n \"last_billable_usage_hour\": \"1953-04-05T16:10:25.944Z\",\n \"org_billable_usage\": -45867309,\n \"percentage_in_account\": -56006310.170947745,\n \"usage_unit\": \"nostrud\"\n },\n \"cspm_host_sum\": {\n \"account_billable_usage\": -57889549,\n \"account_committed_usage\": -11457469,\n \"account_on_demand_usage\": -7957525,\n \"elapsed_usage_hours\": -61084231,\n \"first_billable_usage_hour\": \"1996-10-30T20:43:51.510Z\",\n \"last_billable_usage_hour\": \"2014-02-23T06:18:49.338Z\",\n \"org_billable_usage\": -58149110,\n \"percentage_in_account\": 76680031.69043177,\n \"usage_unit\": \"officia pariatur non dolore in\"\n },\n \"cspm_host_top99p\": {\n \"account_billable_usage\": -46534044,\n \"account_committed_usage\": 55457651,\n \"account_on_demand_usage\": 94937582,\n \"elapsed_usage_hours\": 55221046,\n \"first_billable_usage_hour\": \"1967-03-09T12:57:40.865Z\",\n \"last_billable_usage_hour\": \"2023-09-07T06:41:53.287Z\",\n \"org_billable_usage\": 35356687,\n \"percentage_in_account\": 13336354.378042772,\n \"usage_unit\": \"ipsum\"\n },\n \"custom_event_sum\": {\n \"account_billable_usage\": 16077347,\n \"account_committed_usage\": 64385363,\n \"account_on_demand_usage\": 85665919,\n \"elapsed_usage_hours\": -79245626,\n \"first_billable_usage_hour\": \"2024-06-15T08:42:46.372Z\",\n \"last_billable_usage_hour\": \"1950-07-29T18:24:16.769Z\",\n \"org_billable_usage\": 72656399,\n \"percentage_in_account\": 69430502.43554607,\n \"usage_unit\": \"deserunt nulla id\"\n },\n \"cws_container_sum\": {\n \"account_billable_usage\": 31913283,\n \"account_committed_usage\": -49889800,\n \"account_on_demand_usage\": 34944309,\n \"elapsed_usage_hours\": 52362632,\n \"first_billable_usage_hour\": \"2002-04-12T06:11:51.495Z\",\n \"last_billable_usage_hour\": \"1981-09-22T01:37:17.581Z\",\n \"org_billable_usage\": -60131013,\n \"percentage_in_account\": -66043119.72511361,\n \"usage_unit\": \"do minim\"\n },\n \"cws_host_sum\": {\n \"account_billable_usage\": -58712812,\n \"account_committed_usage\": 31568909,\n \"account_on_demand_usage\": 46716777,\n \"elapsed_usage_hours\": -5996941,\n \"first_billable_usage_hour\": \"1997-07-10T22:04:26.089Z\",\n \"last_billable_usage_hour\": \"1964-05-07T16:03:32.055Z\",\n \"org_billable_usage\": 10402246,\n \"percentage_in_account\": 24248999.027421147,\n \"usage_unit\": \"non anim deserunt\"\n },\n \"cws_host_top99p\": {\n \"account_billable_usage\": -49460139,\n \"account_committed_usage\": -83526723,\n \"account_on_demand_usage\": 93612128,\n \"elapsed_usage_hours\": -53158634,\n \"first_billable_usage_hour\": \"2001-07-30T10:43:59.042Z\",\n \"last_billable_usage_hour\": \"2012-09-08T22:12:05.893Z\",\n \"org_billable_usage\": 3526842,\n \"percentage_in_account\": -12138581.615079612,\n \"usage_unit\": \"incididunt dolore do\"\n },\n \"dbm_host_sum\": {\n \"account_billable_usage\": -78915926,\n \"account_committed_usage\": -48885044,\n \"account_on_demand_usage\": -26208944,\n \"elapsed_usage_hours\": 76958710,\n \"first_billable_usage_hour\": \"2007-03-04T11:52:15.057Z\",\n \"last_billable_usage_hour\": \"1984-09-04T06:04:23.384Z\",\n \"org_billable_usage\": 48108639,\n \"percentage_in_account\": 44722587.838974,\n \"usage_unit\": \"aute cupidatat\"\n },\n \"dbm_host_top99p\": {\n \"account_billable_usage\": -90816630,\n \"account_committed_usage\": 233207,\n \"account_on_demand_usage\": -5074399,\n \"elapsed_usage_hours\": -72219822,\n \"first_billable_usage_hour\": \"2002-02-22T21:07:35.149Z\",\n \"last_billable_usage_hour\": \"2024-06-18T02:17:23.309Z\",\n \"org_billable_usage\": 25886232,\n \"percentage_in_account\": 98360634.83426908,\n \"usage_unit\": \"cupidatat nisi proident mollit\"\n },\n \"dbm_normalized_queries_average\": {\n \"account_billable_usage\": -2502544,\n \"account_committed_usage\": 63596012,\n \"account_on_demand_usage\": 44693720,\n \"elapsed_usage_hours\": -27405741,\n \"first_billable_usage_hour\": \"1960-03-23T15:46:56.918Z\",\n \"last_billable_usage_hour\": \"1991-11-25T02:20:59.786Z\",\n \"org_billable_usage\": -52727979,\n \"percentage_in_account\": 49487574.85230738,\n \"usage_unit\": \"cillum\"\n },\n \"dbm_normalized_queries_sum\": {\n \"account_billable_usage\": 42291006,\n \"account_committed_usage\": 98076072,\n \"account_on_demand_usage\": 8035628,\n \"elapsed_usage_hours\": -53576672,\n \"first_billable_usage_hour\": \"1977-02-17T21:19:58.132Z\",\n \"last_billable_usage_hour\": \"2012-08-08T10:08:54.979Z\",\n \"org_billable_usage\": 26299850,\n \"percentage_in_account\": -2323007.102001235,\n \"usage_unit\": \"veniam eu\"\n },\n \"fargate_container_apm_and_profiler_average\": {\n \"account_billable_usage\": -60051837,\n \"account_committed_usage\": 21542446,\n \"account_on_demand_usage\": 87116146,\n \"elapsed_usage_hours\": 85063189,\n \"first_billable_usage_hour\": \"1990-11-23T00:52:16.453Z\",\n \"last_billable_usage_hour\": \"1993-07-22T15:40:31.080Z\",\n \"org_billable_usage\": 93808086,\n \"percentage_in_account\": 3099399.9945405573,\n \"usage_unit\": \"aliquip ut ad in\"\n },\n \"fargate_container_apm_and_profiler_sum\": {\n \"account_billable_usage\": 35658317,\n \"account_committed_usage\": 84159824,\n \"account_on_demand_usage\": 45340198,\n \"elapsed_usage_hours\": -96824646,\n \"first_billable_usage_hour\": \"1974-02-16T22:09:58.637Z\",\n \"last_billable_usage_hour\": \"2013-06-23T07:41:49.830Z\",\n \"org_billable_usage\": -62283475,\n \"percentage_in_account\": 85642307.10844937,\n \"usage_unit\": \"labore et ut dolor\"\n },\n \"fargate_container_average\": {\n \"account_billable_usage\": -48016224,\n \"account_committed_usage\": -48011406,\n \"account_on_demand_usage\": 9417891,\n \"elapsed_usage_hours\": 6312693,\n \"first_billable_usage_hour\": \"2012-11-02T12:13:45.845Z\",\n \"last_billable_usage_hour\": \"1947-02-13T07:06:24.505Z\",\n \"org_billable_usage\": -96794203,\n \"percentage_in_account\": 73576246.2969802,\n \"usage_unit\": \"consequat in\"\n },\n \"fargate_container_profiler_average\": {\n \"account_billable_usage\": 37262187,\n \"account_committed_usage\": 17318771,\n \"account_on_demand_usage\": -24049243,\n \"elapsed_usage_hours\": 26408301,\n \"first_billable_usage_hour\": \"1959-06-08T16:18:36.992Z\",\n \"last_billable_usage_hour\": \"1952-06-24T15:49:24.445Z\",\n \"org_billable_usage\": 21150501,\n \"percentage_in_account\": -77359316.43634218,\n \"usage_unit\": \"nulla do\"\n },\n \"fargate_container_profiler_sum\": {\n \"account_billable_usage\": 27832559,\n \"account_committed_usage\": 46855077,\n \"account_on_demand_usage\": -8820612,\n \"elapsed_usage_hours\": 23072513,\n \"first_billable_usage_hour\": \"2006-04-11T01:46:46.927Z\",\n \"last_billable_usage_hour\": \"1998-02-17T03:52:45.217Z\",\n \"org_billable_usage\": 86097783,\n \"percentage_in_account\": 19353544.52573499,\n \"usage_unit\": \"exercitation Ut sint veniam\"\n },\n \"fargate_container_sum\": {\n \"account_billable_usage\": 87928332,\n \"account_committed_usage\": -54250726,\n \"account_on_demand_usage\": 69186056,\n \"elapsed_usage_hours\": 74658560,\n \"first_billable_usage_hour\": \"2019-04-25T21:37:13.691Z\",\n \"last_billable_usage_hour\": \"1977-11-13T09:47:00.480Z\",\n \"org_billable_usage\": 75008332,\n \"percentage_in_account\": 82303676.61188135,\n \"usage_unit\": \"dolor\"\n },\n \"incident_management_maximum\": {\n \"account_billable_usage\": 23257689,\n \"account_committed_usage\": -66442433,\n \"account_on_demand_usage\": -15646252,\n \"elapsed_usage_hours\": -20635937,\n \"first_billable_usage_hour\": \"1972-10-23T18:16:15.409Z\",\n \"last_billable_usage_hour\": \"1997-01-31T03:59:46.089Z\",\n \"org_billable_usage\": 85275338,\n \"percentage_in_account\": 25492499.388055906,\n \"usage_unit\": \"officia\"\n },\n \"incident_management_sum\": {\n \"account_billable_usage\": 66965708,\n \"account_committed_usage\": -54339540,\n \"account_on_demand_usage\": -44899289,\n \"elapsed_usage_hours\": -51127635,\n \"first_billable_usage_hour\": \"2011-02-01T15:18:00.963Z\",\n \"last_billable_usage_hour\": \"1983-03-11T21:50:05.544Z\",\n \"org_billable_usage\": 71848779,\n \"percentage_in_account\": -80112496.26320489,\n \"usage_unit\": \"laborum aute\"\n },\n \"infra_and_apm_host_sum\": {\n \"account_billable_usage\": 26509610,\n \"account_committed_usage\": -78235237,\n \"account_on_demand_usage\": -60394541,\n \"elapsed_usage_hours\": -74841603,\n \"first_billable_usage_hour\": \"1960-05-22T20:08:37.399Z\",\n \"last_billable_usage_hour\": \"1985-10-09T20:02:24.284Z\",\n \"org_billable_usage\": 90674566,\n \"percentage_in_account\": -64940516.091109954,\n \"usage_unit\": \"reprehenderit elit deserunt qui\"\n },\n \"infra_and_apm_host_top99p\": {\n \"account_billable_usage\": 20966816,\n \"account_committed_usage\": 46754722,\n \"account_on_demand_usage\": -61045684,\n \"elapsed_usage_hours\": -11033956,\n \"first_billable_usage_hour\": \"2006-10-09T09:13:27.378Z\",\n \"last_billable_usage_hour\": \"1966-06-22T22:11:45.704Z\",\n \"org_billable_usage\": 26410713,\n \"percentage_in_account\": -73520864.72442392,\n \"usage_unit\": \"Excepteur ad magna voluptate\"\n },\n \"infra_container_sum\": {\n \"account_billable_usage\": 33962079,\n \"account_committed_usage\": 29592548,\n \"account_on_demand_usage\": 68971730,\n \"elapsed_usage_hours\": -83832781,\n \"first_billable_usage_hour\": \"1949-12-07T06:52:23.452Z\",\n \"last_billable_usage_hour\": \"2005-03-10T05:19:49.549Z\",\n \"org_billable_usage\": -76385100,\n \"percentage_in_account\": 29566202.506581113,\n \"usage_unit\": \"occaecat id Ut Lorem\"\n },\n \"infra_host_sum\": {\n \"account_billable_usage\": -22112907,\n \"account_committed_usage\": -23917760,\n \"account_on_demand_usage\": 80463255,\n \"elapsed_usage_hours\": 19115168,\n \"first_billable_usage_hour\": \"2003-09-19T15:06:54.822Z\",\n \"last_billable_usage_hour\": \"2004-07-30T00:25:13.014Z\",\n \"org_billable_usage\": 34115135,\n \"percentage_in_account\": 61982167.38064358,\n \"usage_unit\": \"esse in et el\"\n },\n \"infra_host_top99p\": {\n \"account_billable_usage\": -68826162,\n \"account_committed_usage\": -68739622,\n \"account_on_demand_usage\": 27622470,\n \"elapsed_usage_hours\": 37572258,\n \"first_billable_usage_hour\": \"2018-09-15T22:10:36.245Z\",\n \"last_billable_usage_hour\": \"2006-10-01T00:20:57.893Z\",\n \"org_billable_usage\": -11999581,\n \"percentage_in_account\": 72688552.3618908,\n \"usage_unit\": \"fugiat Lorem nostrud\"\n },\n \"ingested_spans_sum\": {\n \"account_billable_usage\": 10603888,\n \"account_committed_usage\": -99701377,\n \"account_on_demand_usage\": -51450170,\n \"elapsed_usage_hours\": 27246637,\n \"first_billable_usage_hour\": \"2002-10-16T04:11:43.572Z\",\n \"last_billable_usage_hour\": \"2018-06-18T08:28:26.904Z\",\n \"org_billable_usage\": -25410747,\n \"percentage_in_account\": -77449166.3331323,\n \"usage_unit\": \"sed officia aute\"\n },\n \"ingested_timeseries_average\": {\n \"account_billable_usage\": -54147415,\n \"account_committed_usage\": -15070652,\n \"account_on_demand_usage\": 85491940,\n \"elapsed_usage_hours\": 49818816,\n \"first_billable_usage_hour\": \"2013-07-09T16:26:14.003Z\",\n \"last_billable_usage_hour\": \"1966-11-13T07:21:25.375Z\",\n \"org_billable_usage\": 869218,\n \"percentage_in_account\": -76605705.73910041,\n \"usage_unit\": \"dolor ea\"\n },\n \"ingested_timeseries_sum\": {\n \"account_billable_usage\": -98412078,\n \"account_committed_usage\": 97754173,\n \"account_on_demand_usage\": -82684448,\n \"elapsed_usage_hours\": -78568018,\n \"first_billable_usage_hour\": \"1951-09-17T03:13:15.552Z\",\n \"last_billable_usage_hour\": \"1988-01-21T01:24:14.994Z\",\n \"org_billable_usage\": 93944366,\n \"percentage_in_account\": -93094704.29620424,\n \"usage_unit\": \"aliqua proident\"\n },\n \"iot_sum\": {\n \"account_billable_usage\": 73466225,\n \"account_committed_usage\": 315094,\n \"account_on_demand_usage\": -14959455,\n \"elapsed_usage_hours\": 91269425,\n \"first_billable_usage_hour\": \"2007-03-24T16:34:21.408Z\",\n \"last_billable_usage_hour\": \"1950-08-31T19:36:52.591Z\",\n \"org_billable_usage\": -34690074,\n \"percentage_in_account\": 78610242.51784715,\n \"usage_unit\": \"eu minim adipisicing quis\"\n },\n \"iot_top99p\": {\n \"account_billable_usage\": -98942487,\n \"account_committed_usage\": 45372300,\n \"account_on_demand_usage\": 14686960,\n \"elapsed_usage_hours\": -6820155,\n \"first_billable_usage_hour\": \"1975-04-09T14:58:08.423Z\",\n \"last_billable_usage_hour\": \"1954-09-08T05:44:38.631Z\",\n \"org_billable_usage\": -72036266,\n \"percentage_in_account\": -7054854.042739615,\n \"usage_unit\": \"enim dolore officia\"\n },\n \"lambda_function_average\": {\n \"account_billable_usage\": 96753424,\n \"account_committed_usage\": 8633324,\n \"account_on_demand_usage\": 32555047,\n \"elapsed_usage_hours\": -51287483,\n \"first_billable_usage_hour\": \"1987-05-08T04:12:00.571Z\",\n \"last_billable_usage_hour\": \"2016-07-08T12:46:32.333Z\",\n \"org_billable_usage\": 98789814,\n \"percentage_in_account\": 77316437.20957914,\n \"usage_unit\": \"fugiat culpa aliqua commodo\"\n },\n \"lambda_function_sum\": {\n \"account_billable_usage\": -20821853,\n \"account_committed_usage\": -25779864,\n \"account_on_demand_usage\": -98353245,\n \"elapsed_usage_hours\": -48577415,\n \"first_billable_usage_hour\": \"1958-04-28T13:32:46.369Z\",\n \"last_billable_usage_hour\": \"1997-05-26T18:35:18.139Z\",\n \"org_billable_usage\": -4946005,\n \"percentage_in_account\": 34895030.154972225,\n \"usage_unit\": \"mollit dolor\"\n },\n \"logs_forwarding_sum\": {\n \"account_billable_usage\": -536999,\n \"account_committed_usage\": -3753601,\n \"account_on_demand_usage\": -14389420,\n \"elapsed_usage_hours\": 14495992,\n \"first_billable_usage_hour\": \"1962-07-18T06:49:54.475Z\",\n \"last_billable_usage_hour\": \"2017-08-28T07:36:38.125Z\",\n \"org_billable_usage\": -67513136,\n \"percentage_in_account\": -89901235.83493605,\n \"usage_unit\": \"Lorem anim enim\"\n },\n \"logs_indexed_15day_sum\": {\n \"account_billable_usage\": 12892215,\n \"account_committed_usage\": -34268598,\n \"account_on_demand_usage\": -28568536,\n \"elapsed_usage_hours\": -57825830,\n \"first_billable_usage_hour\": \"1990-05-27T00:59:15.594Z\",\n \"last_billable_usage_hour\": \"1993-03-18T00:39:15.629Z\",\n \"org_billable_usage\": -13670422,\n \"percentage_in_account\": 58908920.76302549,\n \"usage_unit\": \"mollit aliquip\"\n },\n \"logs_indexed_180day_sum\": {\n \"account_billable_usage\": -58246578,\n \"account_committed_usage\": 27712268,\n \"account_on_demand_usage\": -88680733,\n \"elapsed_usage_hours\": -98895076,\n \"first_billable_usage_hour\": \"1956-11-03T08:38:21.026Z\",\n \"last_billable_usage_hour\": \"2006-05-26T00:55:28.855Z\",\n \"org_billable_usage\": 46136723,\n \"percentage_in_account\": -56055274.51867094,\n \"usage_unit\": \"veniam dolor sit\"\n },\n \"logs_indexed_1day_sum\": {\n \"account_billable_usage\": -77046928,\n \"account_committed_usage\": 58504059,\n \"account_on_demand_usage\": -39215501,\n \"elapsed_usage_hours\": -32913447,\n \"first_billable_usage_hour\": \"1966-07-30T19:27:45.122Z\",\n \"last_billable_usage_hour\": \"1991-06-20T14:09:48.823Z\",\n \"org_billable_usage\": -64379910,\n \"percentage_in_account\": -94989971.21697423,\n \"usage_unit\": \"ut in\"\n },\n \"logs_indexed_30day_sum\": {\n \"account_billable_usage\": 6143842,\n \"account_committed_usage\": 52624117,\n \"account_on_demand_usage\": -39350293,\n \"elapsed_usage_hours\": -59890949,\n \"first_billable_usage_hour\": \"2013-10-12T01:54:05.154Z\",\n \"last_billable_usage_hour\": \"2005-09-26T05:20:58.626Z\",\n \"org_billable_usage\": 88855298,\n \"percentage_in_account\": 20168719.809896246,\n \"usage_unit\": \"nostrud exercitation amet deserunt nulla\"\n },\n \"logs_indexed_360day_sum\": {\n \"account_billable_usage\": 84287170,\n \"account_committed_usage\": -85638462,\n \"account_on_demand_usage\": -86510924,\n \"elapsed_usage_hours\": 71081962,\n \"first_billable_usage_hour\": \"1969-02-25T01:43:47.182Z\",\n \"last_billable_usage_hour\": \"1966-05-01T18:47:06.194Z\",\n \"org_billable_usage\": -65189991,\n \"percentage_in_account\": 14662844.974544689,\n \"usage_unit\": \"reprehenderit est\"\n },\n \"logs_indexed_3day_sum\": {\n \"account_billable_usage\": -89279580,\n \"account_committed_usage\": 20427185,\n \"account_on_demand_usage\": -74924740,\n \"elapsed_usage_hours\": -61683405,\n \"first_billable_usage_hour\": \"1995-10-10T09:43:18.087Z\",\n \"last_billable_usage_hour\": \"2014-12-14T04:12:07.947Z\",\n \"org_billable_usage\": -78904929,\n \"percentage_in_account\": 24450993.75542821,\n \"usage_unit\": \"mollit velit\"\n },\n \"logs_indexed_45day_sum\": {\n \"account_billable_usage\": 99615619,\n \"account_committed_usage\": -33350683,\n \"account_on_demand_usage\": -48456537,\n \"elapsed_usage_hours\": 85098900,\n \"first_billable_usage_hour\": \"2024-01-06T14:19:49.838Z\",\n \"last_billable_usage_hour\": \"1978-11-02T09:46:13.366Z\",\n \"org_billable_usage\": -26250132,\n \"percentage_in_account\": -60137492.45356403,\n \"usage_unit\": \"in exercitation est eu\"\n },\n \"logs_indexed_60day_sum\": {\n \"account_billable_usage\": 24673048,\n \"account_committed_usage\": 55394921,\n \"account_on_demand_usage\": -63798383,\n \"elapsed_usage_hours\": -77262431,\n \"first_billable_usage_hour\": \"1969-09-01T22:35:08.342Z\",\n \"last_billable_usage_hour\": \"1946-09-30T15:06:00.720Z\",\n \"org_billable_usage\": 94450779,\n \"percentage_in_account\": -81528006.48487088,\n \"usage_unit\": \"aute Lorem cillum sint in\"\n },\n \"logs_indexed_7day_sum\": {\n \"account_billable_usage\": -39412123,\n \"account_committed_usage\": 61001330,\n \"account_on_demand_usage\": -73932240,\n \"elapsed_usage_hours\": 28823801,\n \"first_billable_usage_hour\": \"2012-04-11T13:36:47.132Z\",\n \"last_billable_usage_hour\": \"1946-10-15T18:18:21.147Z\",\n \"org_billable_usage\": 81519609,\n \"percentage_in_account\": 55405992.24272734,\n \"usage_unit\": \"amet adipisicing velit dolore\"\n },\n \"logs_indexed_90day_sum\": {\n \"account_billable_usage\": 54287960,\n \"account_committed_usage\": 38852957,\n \"account_on_demand_usage\": -69959227,\n \"elapsed_usage_hours\": -95416174,\n \"first_billable_usage_hour\": \"1973-04-06T08:35:08.396Z\",\n \"last_billable_usage_hour\": \"1965-10-12T12:19:01.597Z\",\n \"org_billable_usage\": 99010954,\n \"percentage_in_account\": -67497023.3556861,\n \"usage_unit\": \"deserunt Excepteur commodo occaecat\"\n },\n \"logs_indexed_custom_retention_sum\": {\n \"account_billable_usage\": 13645417,\n \"account_committed_usage\": 5003536,\n \"account_on_demand_usage\": -695227,\n \"elapsed_usage_hours\": -9734090,\n \"first_billable_usage_hour\": \"2013-05-03T05:08:00.683Z\",\n \"last_billable_usage_hour\": \"1951-07-05T02:06:25.285Z\",\n \"org_billable_usage\": -31535851,\n \"percentage_in_account\": -73226111.84416759,\n \"usage_unit\": \"commodo officia non ut\"\n },\n \"logs_indexed_sum\": {\n \"account_billable_usage\": 34403028,\n \"account_committed_usage\": -84450690,\n \"account_on_demand_usage\": 21648892,\n \"elapsed_usage_hours\": -32631778,\n \"first_billable_usage_hour\": \"1964-04-19T12:32:49.246Z\",\n \"last_billable_usage_hour\": \"1950-04-09T03:04:52.537Z\",\n \"org_billable_usage\": -64693236,\n \"percentage_in_account\": 68972083.18960702,\n \"usage_unit\": \"ut nostrud\"\n },\n \"logs_ingested_sum\": {\n \"account_billable_usage\": -20735359,\n \"account_committed_usage\": -13168990,\n \"account_on_demand_usage\": 35009752,\n \"elapsed_usage_hours\": -41356971,\n \"first_billable_usage_hour\": \"1981-01-15T04:17:54.826Z\",\n \"last_billable_usage_hour\": \"2021-01-25T08:35:45.996Z\",\n \"org_billable_usage\": -8311952,\n \"percentage_in_account\": 92385620.29600257,\n \"usage_unit\": \"qui esse elit Ut\"\n },\n \"network_device_sum\": {\n \"account_billable_usage\": -87264732,\n \"account_committed_usage\": 75876186,\n \"account_on_demand_usage\": -63685033,\n \"elapsed_usage_hours\": 56275441,\n \"first_billable_usage_hour\": \"2024-09-04T13:40:37.459Z\",\n \"last_billable_usage_hour\": \"2023-11-26T00:42:10.941Z\",\n \"org_billable_usage\": -46707754,\n \"percentage_in_account\": -87197677.40567121,\n \"usage_unit\": \"nisi sit ex Ut dolor\"\n },\n \"network_device_top99p\": {\n \"account_billable_usage\": 32574032,\n \"account_committed_usage\": -62959907,\n \"account_on_demand_usage\": -11807231,\n \"elapsed_usage_hours\": 26835626,\n \"first_billable_usage_hour\": \"1954-02-25T11:31:41.258Z\",\n \"last_billable_usage_hour\": \"1988-01-03T10:18:34.347Z\",\n \"org_billable_usage\": -41521739,\n \"percentage_in_account\": -84463365.8522815,\n \"usage_unit\": \"est\"\n },\n \"npm_flow_sum\": {\n \"account_billable_usage\": -57967732,\n \"account_committed_usage\": 48815537,\n \"account_on_demand_usage\": -48259481,\n \"elapsed_usage_hours\": 41402068,\n \"first_billable_usage_hour\": \"1992-03-10T16:08:44.170Z\",\n \"last_billable_usage_hour\": \"2017-05-31T23:16:07.200Z\",\n \"org_billable_usage\": 52223205,\n \"percentage_in_account\": -85064444.58353628,\n \"usage_unit\": \"mollit amet et consectetur\"\n },\n \"npm_host_sum\": {\n \"account_billable_usage\": 56331005,\n \"account_committed_usage\": 55601336,\n \"account_on_demand_usage\": -52301821,\n \"elapsed_usage_hours\": 425837,\n \"first_billable_usage_hour\": \"1980-07-31T03:41:11.589Z\",\n \"last_billable_usage_hour\": \"1947-04-08T20:18:03.491Z\",\n \"org_billable_usage\": -22112492,\n \"percentage_in_account\": -72196592.27514204,\n \"usage_unit\": \"est dolore reprehenderit sed in\"\n },\n \"npm_host_top99p\": {\n \"account_billable_usage\": -85194479,\n \"account_committed_usage\": -64140319,\n \"account_on_demand_usage\": 58585121,\n \"elapsed_usage_hours\": -25912581,\n \"first_billable_usage_hour\": \"2000-09-13T12:35:00.693Z\",\n \"last_billable_usage_hour\": \"2011-10-02T10:28:11.614Z\",\n \"org_billable_usage\": 16244932,\n \"percentage_in_account\": 31138534.954381898,\n \"usage_unit\": \"commodo\"\n },\n \"observability_pipeline_sum\": {\n \"account_billable_usage\": -53911627,\n \"account_committed_usage\": 21804032,\n \"account_on_demand_usage\": 256373,\n \"elapsed_usage_hours\": -5701902,\n \"first_billable_usage_hour\": \"1973-01-22T22:43:06.799Z\",\n \"last_billable_usage_hour\": \"1991-11-18T09:29:08.127Z\",\n \"org_billable_usage\": -43994188,\n \"percentage_in_account\": -4549421.937540889,\n \"usage_unit\": \"dolor ut au\"\n },\n \"online_archive_sum\": {\n \"account_billable_usage\": 35834689,\n \"account_committed_usage\": -22741582,\n \"account_on_demand_usage\": 64585230,\n \"elapsed_usage_hours\": 47138522,\n \"first_billable_usage_hour\": \"1996-09-04T04:55:31.703Z\",\n \"last_billable_usage_hour\": \"1965-07-19T21:05:17.181Z\",\n \"org_billable_usage\": 29033368,\n \"percentage_in_account\": -59883299.45295567,\n \"usage_unit\": \"ut pariatur\"\n },\n \"prof_container_sum\": {\n \"account_billable_usage\": -66178376,\n \"account_committed_usage\": 90718740,\n \"account_on_demand_usage\": -65843387,\n \"elapsed_usage_hours\": -12463139,\n \"first_billable_usage_hour\": \"1950-01-17T16:52:53.826Z\",\n \"last_billable_usage_hour\": \"1981-03-11T12:50:33.997Z\",\n \"org_billable_usage\": 38235280,\n \"percentage_in_account\": -91999662.12222584,\n \"usage_unit\": \"veniam dolor non et laboris\"\n },\n \"prof_host_sum\": {\n \"account_billable_usage\": 41837076,\n \"account_committed_usage\": 27117116,\n \"account_on_demand_usage\": 89337401,\n \"elapsed_usage_hours\": 75481884,\n \"first_billable_usage_hour\": \"2018-08-10T04:45:20.263Z\",\n \"last_billable_usage_hour\": \"2002-06-15T03:59:32.901Z\",\n \"org_billable_usage\": -35512465,\n \"percentage_in_account\": 47401644.07349986,\n \"usage_unit\": \"laboris nulla\"\n },\n \"prof_host_top99p\": {\n \"account_billable_usage\": -80640570,\n \"account_committed_usage\": -34107328,\n \"account_on_demand_usage\": 32223997,\n \"elapsed_usage_hours\": 85028666,\n \"first_billable_usage_hour\": \"1966-05-21T20:06:44.256Z\",\n \"last_billable_usage_hour\": \"2012-04-18T13:18:57.249Z\",\n \"org_billable_usage\": 77696484,\n \"percentage_in_account\": 4333486.688508794,\n \"usage_unit\": \"consequat in nisi dolore\"\n },\n \"rum_lite_sum\": {\n \"account_billable_usage\": 96481847,\n \"account_committed_usage\": 36799242,\n \"account_on_demand_usage\": -29342283,\n \"elapsed_usage_hours\": 4344954,\n \"first_billable_usage_hour\": \"2014-10-16T09:46:38.575Z\",\n \"last_billable_usage_hour\": \"1960-06-16T03:07:58.293Z\",\n \"org_billable_usage\": 77144986,\n \"percentage_in_account\": -5544272.612701431,\n \"usage_unit\": \"minim\"\n },\n \"rum_replay_sum\": {\n \"account_billable_usage\": 39489920,\n \"account_committed_usage\": 98519410,\n \"account_on_demand_usage\": 40127275,\n \"elapsed_usage_hours\": 59967628,\n \"first_billable_usage_hour\": \"1992-03-22T09:25:57.165Z\",\n \"last_billable_usage_hour\": \"1961-03-25T20:29:41.542Z\",\n \"org_billable_usage\": 47525116,\n \"percentage_in_account\": -98082479.88741755,\n \"usage_unit\": \"ut veniam mollit proident\"\n },\n \"rum_sum\": {\n \"account_billable_usage\": -65341819,\n \"account_committed_usage\": 72564444,\n \"account_on_demand_usage\": 92918684,\n \"elapsed_usage_hours\": -67249968,\n \"first_billable_usage_hour\": \"2003-08-14T13:57:55.411Z\",\n \"last_billable_usage_hour\": \"1968-03-04T18:09:51.693Z\",\n \"org_billable_usage\": -3827228,\n \"percentage_in_account\": -60073382.23821148,\n \"usage_unit\": \"culpa pariatur qui\"\n },\n \"rum_units_sum\": {\n \"account_billable_usage\": -73429002,\n \"account_committed_usage\": -24663108,\n \"account_on_demand_usage\": -19850495,\n \"elapsed_usage_hours\": 39215066,\n \"first_billable_usage_hour\": \"1945-10-26T07:39:45.958Z\",\n \"last_billable_usage_hour\": \"1960-01-01T06:25:55.131Z\",\n \"org_billable_usage\": 34654219,\n \"percentage_in_account\": 17778844.089535385,\n \"usage_unit\": \"esse et\"\n },\n \"sensitive_data_scanner_sum\": {\n \"account_billable_usage\": -95179173,\n \"account_committed_usage\": 64750571,\n \"account_on_demand_usage\": 20899474,\n \"elapsed_usage_hours\": -52662115,\n \"first_billable_usage_hour\": \"1956-03-05T20:06:26.915Z\",\n \"last_billable_usage_hour\": \"1986-12-18T17:43:16.049Z\",\n \"org_billable_usage\": -26000408,\n \"percentage_in_account\": -27347871.280624434,\n \"usage_unit\": \"tempor adipisicing est\"\n },\n \"serverless_apm_sum\": {\n \"account_billable_usage\": 78837179,\n \"account_committed_usage\": 95032281,\n \"account_on_demand_usage\": -83232978,\n \"elapsed_usage_hours\": 89023278,\n \"first_billable_usage_hour\": \"1973-01-17T19:55:27.977Z\",\n \"last_billable_usage_hour\": \"1997-10-30T11:31:24.899Z\",\n \"org_billable_usage\": 58146641,\n \"percentage_in_account\": 88506422.17885193,\n \"usage_unit\": \"Ut nisi\"\n },\n \"serverless_infra_average\": {\n \"account_billable_usage\": 84068776,\n \"account_committed_usage\": 84917285,\n \"account_on_demand_usage\": -60768763,\n \"elapsed_usage_hours\": -40257762,\n \"first_billable_usage_hour\": \"1956-09-16T14:16:26.271Z\",\n \"last_billable_usage_hour\": \"2023-04-22T22:26:14.043Z\",\n \"org_billable_usage\": 88385583,\n \"percentage_in_account\": 66023331.115201086,\n \"usage_unit\": \"in reprehenderit\"\n },\n \"serverless_infra_sum\": {\n \"account_billable_usage\": 99238175,\n \"account_committed_usage\": 76110217,\n \"account_on_demand_usage\": -8849987,\n \"elapsed_usage_hours\": 41239596,\n \"first_billable_usage_hour\": \"1981-01-28T17:26:51.910Z\",\n \"last_billable_usage_hour\": \"2016-08-31T10:05:20.538Z\",\n \"org_billable_usage\": 42787049,\n \"percentage_in_account\": -49951392.06361068,\n \"usage_unit\": \"nostrud officia consectetur sed sit\"\n },\n \"serverless_invocation_sum\": {\n \"account_billable_usage\": 44121466,\n \"account_committed_usage\": 24759896,\n \"account_on_demand_usage\": 51921199,\n \"elapsed_usage_hours\": -95158302,\n \"first_billable_usage_hour\": \"1959-12-14T01:26:43.499Z\",\n \"last_billable_usage_hour\": \"2001-07-21T20:50:18.513Z\",\n \"org_billable_usage\": -4754511,\n \"percentage_in_account\": -55675847.63581204,\n \"usage_unit\": \"dolor qui elit exercitation\"\n },\n \"siem_sum\": {\n \"account_billable_usage\": 44488048,\n \"account_committed_usage\": 93155869,\n \"account_on_demand_usage\": -4018347,\n \"elapsed_usage_hours\": 2709843,\n \"first_billable_usage_hour\": \"1969-05-20T22:42:22.268Z\",\n \"last_billable_usage_hour\": \"1997-09-24T20:33:28.432Z\",\n \"org_billable_usage\": 26770537,\n \"percentage_in_account\": -77835830.90793322,\n \"usage_unit\": \"sit voluptate\"\n },\n \"standard_timeseries_average\": {\n \"account_billable_usage\": 53320946,\n \"account_committed_usage\": 91938479,\n \"account_on_demand_usage\": -29617774,\n \"elapsed_usage_hours\": -9182064,\n \"first_billable_usage_hour\": \"1965-04-05T20:57:27.810Z\",\n \"last_billable_usage_hour\": \"1983-01-10T01:37:48.589Z\",\n \"org_billable_usage\": -50813441,\n \"percentage_in_account\": 8996808.850994915,\n \"usage_unit\": \"aute ut quis ullamco culpa\"\n },\n \"synthetics_api_tests_sum\": {\n \"account_billable_usage\": 41276328,\n \"account_committed_usage\": 75293263,\n \"account_on_demand_usage\": -8794754,\n \"elapsed_usage_hours\": -50251774,\n \"first_billable_usage_hour\": \"1978-09-02T06:41:49.951Z\",\n \"last_billable_usage_hour\": \"1981-11-25T08:10:13.983Z\",\n \"org_billable_usage\": -75733685,\n \"percentage_in_account\": 40747875.60490894,\n \"usage_unit\": \"occaecat sed Ut\"\n },\n \"synthetics_app_testing_maximum\": {\n \"account_billable_usage\": 31257930,\n \"account_committed_usage\": 82841490,\n \"account_on_demand_usage\": -70827562,\n \"elapsed_usage_hours\": -92593705,\n \"first_billable_usage_hour\": \"2014-05-05T23:10:18.068Z\",\n \"last_billable_usage_hour\": \"2008-11-29T16:22:02.466Z\",\n \"org_billable_usage\": 95926804,\n \"percentage_in_account\": 74550682.91952324,\n \"usage_unit\": \"ut cupidatat\"\n },\n \"synthetics_browser_checks_sum\": {\n \"account_billable_usage\": -24011456,\n \"account_committed_usage\": 51453726,\n \"account_on_demand_usage\": 69309908,\n \"elapsed_usage_hours\": 35024350,\n \"first_billable_usage_hour\": \"1961-09-08T16:41:40.365Z\",\n \"last_billable_usage_hour\": \"1959-06-27T16:31:56.377Z\",\n \"org_billable_usage\": -24672495,\n \"percentage_in_account\": 3421549.9188408107,\n \"usage_unit\": \"eu deserunt dolor\"\n },\n \"timeseries_average\": {\n \"account_billable_usage\": -5359699,\n \"account_committed_usage\": 96740077,\n \"account_on_demand_usage\": 7188571,\n \"elapsed_usage_hours\": -96823565,\n \"first_billable_usage_hour\": \"1986-06-14T01:01:13.736Z\",\n \"last_billable_usage_hour\": \"1995-05-25T23:09:12.624Z\",\n \"org_billable_usage\": 64264622,\n \"percentage_in_account\": -5643210.213463396,\n \"usage_unit\": \"quis occaecat Ut tempor\"\n },\n \"timeseries_sum\": {\n \"account_billable_usage\": -57508100,\n \"account_committed_usage\": -4239222,\n \"account_on_demand_usage\": 69089416,\n \"elapsed_usage_hours\": -88512387,\n \"first_billable_usage_hour\": \"1967-11-12T05:45:29.851Z\",\n \"last_billable_usage_hour\": \"2015-06-19T17:25:30.223Z\",\n \"org_billable_usage\": -67283540,\n \"percentage_in_account\": 27642339.871466756,\n \"usage_unit\": \"commodo d\"\n }\n }\n },\n {\n \"account_name\": \"dolore pariatur Duis commodo ut\",\n \"account_public_id\": \"co\",\n \"billing_plan\": \"mollit cillum fugiat ullamco\",\n \"end_date\": \"1976-11-14T14:13:09.515Z\",\n \"num_orgs\": -16176637,\n \"org_name\": \"veniam Lorem id sint\",\n \"public_id\": \"cillum velit Lorem\",\n \"ratio_in_month\": -7930537.997272372,\n \"region\": \"ut\",\n \"start_date\": \"1953-08-08T02:32:07.560Z\",\n \"usage\": {\n \"apm_fargate_average\": {\n \"account_billable_usage\": 83380781,\n \"account_committed_usage\": 11196892,\n \"account_on_demand_usage\": 89831717,\n \"elapsed_usage_hours\": 31979126,\n \"first_billable_usage_hour\": \"2018-08-03T15:08:46.597Z\",\n \"last_billable_usage_hour\": \"1965-10-28T08:00:19.657Z\",\n \"org_billable_usage\": 90607062,\n \"percentage_in_account\": -68607013.00898966,\n \"usage_unit\": \"voluptate incididunt Ut\"\n },\n \"apm_fargate_sum\": {\n \"account_billable_usage\": 92551233,\n \"account_committed_usage\": 7099900,\n \"account_on_demand_usage\": 88670013,\n \"elapsed_usage_hours\": -12181345,\n \"first_billable_usage_hour\": \"2009-10-28T11:08:20.936Z\",\n \"last_billable_usage_hour\": \"1963-11-15T19:35:35.946Z\",\n \"org_billable_usage\": -89583226,\n \"percentage_in_account\": -319931.890715003,\n \"usage_unit\": \"exercitation nisi laboris\"\n },\n \"apm_host_sum\": {\n \"account_billable_usage\": -34137624,\n \"account_committed_usage\": -92054552,\n \"account_on_demand_usage\": 25502056,\n \"elapsed_usage_hours\": -17579930,\n \"first_billable_usage_hour\": \"1959-08-07T04:17:32.923Z\",\n \"last_billable_usage_hour\": \"1996-06-13T14:25:02.663Z\",\n \"org_billable_usage\": 29357272,\n \"percentage_in_account\": 54167683.63538149,\n \"usage_unit\": \"culpa ullamco id amet\"\n },\n \"apm_host_top99p\": {\n \"account_billable_usage\": 70892679,\n \"account_committed_usage\": -42271960,\n \"account_on_demand_usage\": -92289535,\n \"elapsed_usage_hours\": -53361324,\n \"first_billable_usage_hour\": \"2013-10-04T09:13:25.619Z\",\n \"last_billable_usage_hour\": \"1981-10-22T01:10:34.136Z\",\n \"org_billable_usage\": -13188319,\n \"percentage_in_account\": 91958684.22781685,\n \"usage_unit\": \"dolor enim velit tem\"\n },\n \"apm_profiler_host_sum\": {\n \"account_billable_usage\": -70513344,\n \"account_committed_usage\": 90518008,\n \"account_on_demand_usage\": 32631761,\n \"elapsed_usage_hours\": 16926932,\n \"first_billable_usage_hour\": \"1992-01-28T05:05:18.267Z\",\n \"last_billable_usage_hour\": \"2023-10-21T12:24:05.416Z\",\n \"org_billable_usage\": -3477706,\n \"percentage_in_account\": 53292105.0272665,\n \"usage_unit\": \"exercitation ullamco mol\"\n },\n \"apm_profiler_host_top99p\": {\n \"account_billable_usage\": 8416678,\n \"account_committed_usage\": 27917540,\n \"account_on_demand_usage\": -84807359,\n \"elapsed_usage_hours\": -61730578,\n \"first_billable_usage_hour\": \"1967-04-09T02:41:49.367Z\",\n \"last_billable_usage_hour\": \"1967-06-23T06:53:43.664Z\",\n \"org_billable_usage\": -74688118,\n \"percentage_in_account\": -64558693.786270104,\n \"usage_unit\": \"magna dolore\"\n },\n \"apm_trace_search_sum\": {\n \"account_billable_usage\": 86285597,\n \"account_committed_usage\": -31361589,\n \"account_on_demand_usage\": 33765952,\n \"elapsed_usage_hours\": -67927243,\n \"first_billable_usage_hour\": \"2000-06-30T07:36:48.769Z\",\n \"last_billable_usage_hour\": \"1953-04-27T12:06:11.034Z\",\n \"org_billable_usage\": -67499975,\n \"percentage_in_account\": 10898321.85139595,\n \"usage_unit\": \"id dolor Lorem\"\n },\n \"application_security_fargate_average\": {\n \"account_billable_usage\": -93547619,\n \"account_committed_usage\": 90652749,\n \"account_on_demand_usage\": -6961494,\n \"elapsed_usage_hours\": -91400627,\n \"first_billable_usage_hour\": \"1959-11-19T18:46:01.876Z\",\n \"last_billable_usage_hour\": \"2002-10-28T01:26:47.676Z\",\n \"org_billable_usage\": -89486274,\n \"percentage_in_account\": -6500929.9904424995,\n \"usage_unit\": \"irure magna non\"\n },\n \"application_security_host_sum\": {\n \"account_billable_usage\": 82936807,\n \"account_committed_usage\": 7192883,\n \"account_on_demand_usage\": -62733863,\n \"elapsed_usage_hours\": -19762500,\n \"first_billable_usage_hour\": \"1963-04-23T02:55:43.304Z\",\n \"last_billable_usage_hour\": \"1992-02-16T20:31:37.745Z\",\n \"org_billable_usage\": -11298598,\n \"percentage_in_account\": -58884912.687815815,\n \"usage_unit\": \"deserunt reprehenderit ad\"\n },\n \"application_security_host_top99p\": {\n \"account_billable_usage\": 98815993,\n \"account_committed_usage\": -49710409,\n \"account_on_demand_usage\": 36788228,\n \"elapsed_usage_hours\": 68506306,\n \"first_billable_usage_hour\": \"2023-05-19T16:18:52.554Z\",\n \"last_billable_usage_hour\": \"1954-04-11T19:59:58.682Z\",\n \"org_billable_usage\": -45039668,\n \"percentage_in_account\": 21899140.832771644,\n \"usage_unit\": \"tempor esse fugiat elit ex\"\n },\n \"ci_pipeline_indexed_spans_sum\": {\n \"account_billable_usage\": -45175931,\n \"account_committed_usage\": 78829702,\n \"account_on_demand_usage\": -87071594,\n \"elapsed_usage_hours\": 61270565,\n \"first_billable_usage_hour\": \"2010-10-14T23:32:23.029Z\",\n \"last_billable_usage_hour\": \"1959-09-12T09:06:55.927Z\",\n \"org_billable_usage\": 43496629,\n \"percentage_in_account\": 78641277.03333065,\n \"usage_unit\": \"aliquip sed\"\n },\n \"ci_pipeline_maximum\": {\n \"account_billable_usage\": 99134269,\n \"account_committed_usage\": -88836483,\n \"account_on_demand_usage\": 64281097,\n \"elapsed_usage_hours\": 83924161,\n \"first_billable_usage_hour\": \"1977-10-24T18:36:20.363Z\",\n \"last_billable_usage_hour\": \"2002-07-14T15:27:15.997Z\",\n \"org_billable_usage\": 99274123,\n \"percentage_in_account\": 56071061.97193587,\n \"usage_unit\": \"sit sunt dolore proid\"\n },\n \"ci_pipeline_sum\": {\n \"account_billable_usage\": -63168562,\n \"account_committed_usage\": -7340672,\n \"account_on_demand_usage\": 53819079,\n \"elapsed_usage_hours\": -70160033,\n \"first_billable_usage_hour\": \"1988-07-17T09:53:20.112Z\",\n \"last_billable_usage_hour\": \"1982-03-22T03:51:33.021Z\",\n \"org_billable_usage\": 89099684,\n \"percentage_in_account\": -69563506.42733838,\n \"usage_unit\": \"consectetur aliqua voluptate\"\n },\n \"ci_test_indexed_spans_sum\": {\n \"account_billable_usage\": 95548015,\n \"account_committed_usage\": 49519421,\n \"account_on_demand_usage\": -53886832,\n \"elapsed_usage_hours\": 65161735,\n \"first_billable_usage_hour\": \"2006-05-23T10:13:56.427Z\",\n \"last_billable_usage_hour\": \"1955-11-23T16:43:07.922Z\",\n \"org_billable_usage\": 33060607,\n \"percentage_in_account\": 43610292.405735075,\n \"usage_unit\": \"deserunt cillum\"\n },\n \"ci_testing_maximum\": {\n \"account_billable_usage\": 49071557,\n \"account_committed_usage\": -37761111,\n \"account_on_demand_usage\": -80149199,\n \"elapsed_usage_hours\": -13521387,\n \"first_billable_usage_hour\": \"1993-02-17T15:26:32.329Z\",\n \"last_billable_usage_hour\": \"1951-09-10T16:36:38.336Z\",\n \"org_billable_usage\": -9455171,\n \"percentage_in_account\": -51022878.862293996,\n \"usage_unit\": \"dolore\"\n },\n \"ci_testing_sum\": {\n \"account_billable_usage\": 31787310,\n \"account_committed_usage\": -12671777,\n \"account_on_demand_usage\": -91340897,\n \"elapsed_usage_hours\": -59935677,\n \"first_billable_usage_hour\": \"1985-11-05T01:55:17.700Z\",\n \"last_billable_usage_hour\": \"1978-09-11T09:04:20.435Z\",\n \"org_billable_usage\": 31414660,\n \"percentage_in_account\": 47364212.544412285,\n \"usage_unit\": \"do dolor sint\"\n },\n \"cloud_cost_management_average\": {\n \"account_billable_usage\": 19674908,\n \"account_committed_usage\": 51121702,\n \"account_on_demand_usage\": 62098622,\n \"elapsed_usage_hours\": -34057269,\n \"first_billable_usage_hour\": \"1966-02-24T13:57:09.159Z\",\n \"last_billable_usage_hour\": \"1975-05-11T16:14:28.378Z\",\n \"org_billable_usage\": 90522600,\n \"percentage_in_account\": 36009964.96963328,\n \"usage_unit\": \"velit nisi pariatur\"\n },\n \"cloud_cost_management_sum\": {\n \"account_billable_usage\": -94525892,\n \"account_committed_usage\": -60392051,\n \"account_on_demand_usage\": -11210245,\n \"elapsed_usage_hours\": 69567228,\n \"first_billable_usage_hour\": \"2007-01-06T03:27:57.869Z\",\n \"last_billable_usage_hour\": \"1967-08-31T18:56:51.902Z\",\n \"org_billable_usage\": 58309883,\n \"percentage_in_account\": -19541697.86238365,\n \"usage_unit\": \"officia\"\n },\n \"cspm_container_sum\": {\n \"account_billable_usage\": 16336517,\n \"account_committed_usage\": -37173005,\n \"account_on_demand_usage\": -95744977,\n \"elapsed_usage_hours\": -12504490,\n \"first_billable_usage_hour\": \"1954-10-26T21:11:33.778Z\",\n \"last_billable_usage_hour\": \"1947-01-24T14:53:58.281Z\",\n \"org_billable_usage\": -91188617,\n \"percentage_in_account\": -35149184.58382266,\n \"usage_unit\": \"qui aliquip in\"\n },\n \"cspm_host_sum\": {\n \"account_billable_usage\": 76317878,\n \"account_committed_usage\": 9925974,\n \"account_on_demand_usage\": -2793655,\n \"elapsed_usage_hours\": 69035161,\n \"first_billable_usage_hour\": \"1962-02-10T09:45:53.024Z\",\n \"last_billable_usage_hour\": \"1993-10-24T07:12:01.603Z\",\n \"org_billable_usage\": -54290054,\n \"percentage_in_account\": -64372843.25807095,\n \"usage_unit\": \"aute\"\n },\n \"cspm_host_top99p\": {\n \"account_billable_usage\": 91266527,\n \"account_committed_usage\": -42623945,\n \"account_on_demand_usage\": -69270032,\n \"elapsed_usage_hours\": -64611265,\n \"first_billable_usage_hour\": \"1963-08-17T00:10:16.710Z\",\n \"last_billable_usage_hour\": \"1977-05-30T22:14:23.205Z\",\n \"org_billable_usage\": -81864807,\n \"percentage_in_account\": 23686033.23419267,\n \"usage_unit\": \"laborum do sunt Excepteur dolor\"\n },\n \"custom_event_sum\": {\n \"account_billable_usage\": -59521332,\n \"account_committed_usage\": 16135710,\n \"account_on_demand_usage\": -17718878,\n \"elapsed_usage_hours\": -19328706,\n \"first_billable_usage_hour\": \"2003-05-12T06:56:23.250Z\",\n \"last_billable_usage_hour\": \"1947-09-22T02:14:55.144Z\",\n \"org_billable_usage\": 30548125,\n \"percentage_in_account\": 72680576.48011601,\n \"usage_unit\": \"sint ad do reprehenderit qui\"\n },\n \"cws_container_sum\": {\n \"account_billable_usage\": -89990839,\n \"account_committed_usage\": 66718559,\n \"account_on_demand_usage\": 40304108,\n \"elapsed_usage_hours\": 30422753,\n \"first_billable_usage_hour\": \"1987-09-29T05:01:26.155Z\",\n \"last_billable_usage_hour\": \"1959-07-02T21:48:34.776Z\",\n \"org_billable_usage\": -38917730,\n \"percentage_in_account\": -86783679.29088779,\n \"usage_unit\": \"aliquip incididunt consequat\"\n },\n \"cws_host_sum\": {\n \"account_billable_usage\": 22782263,\n \"account_committed_usage\": -38072383,\n \"account_on_demand_usage\": 44680739,\n \"elapsed_usage_hours\": -4308821,\n \"first_billable_usage_hour\": \"1955-11-10T03:11:44.170Z\",\n \"last_billable_usage_hour\": \"2007-01-27T09:35:46.261Z\",\n \"org_billable_usage\": -44961140,\n \"percentage_in_account\": -6484864.432117507,\n \"usage_unit\": \"voluptate\"\n },\n \"cws_host_top99p\": {\n \"account_billable_usage\": 13462211,\n \"account_committed_usage\": 96277958,\n \"account_on_demand_usage\": -61685126,\n \"elapsed_usage_hours\": -37073405,\n \"first_billable_usage_hour\": \"1952-09-18T23:43:16.642Z\",\n \"last_billable_usage_hour\": \"1969-05-04T08:15:20.901Z\",\n \"org_billable_usage\": -95541303,\n \"percentage_in_account\": -34160848.966033906,\n \"usage_unit\": \"ipsum aliquip nostrud\"\n },\n \"dbm_host_sum\": {\n \"account_billable_usage\": 10454057,\n \"account_committed_usage\": 30562696,\n \"account_on_demand_usage\": -83091065,\n \"elapsed_usage_hours\": -88850870,\n \"first_billable_usage_hour\": \"1958-01-20T11:29:29.804Z\",\n \"last_billable_usage_hour\": \"1985-11-22T17:46:09.201Z\",\n \"org_billable_usage\": 4046139,\n \"percentage_in_account\": -50061688.69867744,\n \"usage_unit\": \"ullamco laborum aliquip nulla\"\n },\n \"dbm_host_top99p\": {\n \"account_billable_usage\": 54030161,\n \"account_committed_usage\": 74801357,\n \"account_on_demand_usage\": -96724405,\n \"elapsed_usage_hours\": 24533688,\n \"first_billable_usage_hour\": \"1966-08-23T19:03:41.768Z\",\n \"last_billable_usage_hour\": \"1950-05-26T16:48:28.385Z\",\n \"org_billable_usage\": 71213610,\n \"percentage_in_account\": -33452476.517856523,\n \"usage_unit\": \"consequat reprehenderit\"\n },\n \"dbm_normalized_queries_average\": {\n \"account_billable_usage\": -93554271,\n \"account_committed_usage\": 56625953,\n \"account_on_demand_usage\": -38567576,\n \"elapsed_usage_hours\": -20125720,\n \"first_billable_usage_hour\": \"1974-11-23T18:51:44.978Z\",\n \"last_billable_usage_hour\": \"1999-10-26T07:26:16.834Z\",\n \"org_billable_usage\": 28634540,\n \"percentage_in_account\": 44776950.92181322,\n \"usage_unit\": \"culpa ex veniam\"\n },\n \"dbm_normalized_queries_sum\": {\n \"account_billable_usage\": -78109450,\n \"account_committed_usage\": -31450800,\n \"account_on_demand_usage\": 21088663,\n \"elapsed_usage_hours\": 61949974,\n \"first_billable_usage_hour\": \"1972-05-31T02:43:53.999Z\",\n \"last_billable_usage_hour\": \"1967-07-12T09:15:45.172Z\",\n \"org_billable_usage\": -59529686,\n \"percentage_in_account\": -30759939.77323179,\n \"usage_unit\": \"anim nulla\"\n },\n \"fargate_container_apm_and_profiler_average\": {\n \"account_billable_usage\": 60960962,\n \"account_committed_usage\": -31252400,\n \"account_on_demand_usage\": -98523868,\n \"elapsed_usage_hours\": 95288472,\n \"first_billable_usage_hour\": \"2023-11-16T04:20:32.626Z\",\n \"last_billable_usage_hour\": \"2018-12-04T00:42:47.125Z\",\n \"org_billable_usage\": 48259118,\n \"percentage_in_account\": 81408014.87077352,\n \"usage_unit\": \"est\"\n },\n \"fargate_container_apm_and_profiler_sum\": {\n \"account_billable_usage\": 66177775,\n \"account_committed_usage\": 17206556,\n \"account_on_demand_usage\": 12352998,\n \"elapsed_usage_hours\": -1904498,\n \"first_billable_usage_hour\": \"1962-01-11T03:00:33.165Z\",\n \"last_billable_usage_hour\": \"1971-12-04T21:13:58.282Z\",\n \"org_billable_usage\": 62043206,\n \"percentage_in_account\": -72106145.92804374,\n \"usage_unit\": \"id pariatur et commodo\"\n },\n \"fargate_container_average\": {\n \"account_billable_usage\": 55165603,\n \"account_committed_usage\": -12348424,\n \"account_on_demand_usage\": 81008353,\n \"elapsed_usage_hours\": 67529549,\n \"first_billable_usage_hour\": \"1985-06-12T11:52:25.601Z\",\n \"last_billable_usage_hour\": \"1959-05-08T01:52:07.621Z\",\n \"org_billable_usage\": 17474965,\n \"percentage_in_account\": 5124556.534391463,\n \"usage_unit\": \"ex proident laboris\"\n },\n \"fargate_container_profiler_average\": {\n \"account_billable_usage\": 74247220,\n \"account_committed_usage\": -6703353,\n \"account_on_demand_usage\": 45413273,\n \"elapsed_usage_hours\": 77989749,\n \"first_billable_usage_hour\": \"1947-09-29T21:12:45.488Z\",\n \"last_billable_usage_hour\": \"1968-03-20T08:52:15.756Z\",\n \"org_billable_usage\": 37989406,\n \"percentage_in_account\": -59794348.56404502,\n \"usage_unit\": \"in Duis\"\n },\n \"fargate_container_profiler_sum\": {\n \"account_billable_usage\": -40266400,\n \"account_committed_usage\": 36558427,\n \"account_on_demand_usage\": -60673844,\n \"elapsed_usage_hours\": -6263769,\n \"first_billable_usage_hour\": \"1948-12-09T02:19:59.162Z\",\n \"last_billable_usage_hour\": \"1962-04-14T03:07:57.499Z\",\n \"org_billable_usage\": -43095882,\n \"percentage_in_account\": -11020063.500348628,\n \"usage_unit\": \"mollit\"\n },\n \"fargate_container_sum\": {\n \"account_billable_usage\": 2766941,\n \"account_committed_usage\": -76475127,\n \"account_on_demand_usage\": 42876929,\n \"elapsed_usage_hours\": 446915,\n \"first_billable_usage_hour\": \"1987-06-10T19:58:33.223Z\",\n \"last_billable_usage_hour\": \"1966-09-10T01:28:00.579Z\",\n \"org_billable_usage\": 766403,\n \"percentage_in_account\": -82967562.14867438,\n \"usage_unit\": \"deserunt enim dolor dolore\"\n },\n \"incident_management_maximum\": {\n \"account_billable_usage\": 66594226,\n \"account_committed_usage\": 76500020,\n \"account_on_demand_usage\": 6849906,\n \"elapsed_usage_hours\": 60711550,\n \"first_billable_usage_hour\": \"2014-07-29T08:59:19.389Z\",\n \"last_billable_usage_hour\": \"2000-06-17T03:59:41.110Z\",\n \"org_billable_usage\": -60206730,\n \"percentage_in_account\": 49051612.15921134,\n \"usage_unit\": \"elit Duis\"\n },\n \"incident_management_sum\": {\n \"account_billable_usage\": 62179625,\n \"account_committed_usage\": -63719886,\n \"account_on_demand_usage\": -5449532,\n \"elapsed_usage_hours\": 59627975,\n \"first_billable_usage_hour\": \"1979-09-23T22:20:50.809Z\",\n \"last_billable_usage_hour\": \"1974-01-15T11:53:26.064Z\",\n \"org_billable_usage\": 89527519,\n \"percentage_in_account\": -6369.941783517599,\n \"usage_unit\": \"ut dolor sunt\"\n },\n \"infra_and_apm_host_sum\": {\n \"account_billable_usage\": 13048824,\n \"account_committed_usage\": 15548778,\n \"account_on_demand_usage\": -3666795,\n \"elapsed_usage_hours\": -92603590,\n \"first_billable_usage_hour\": \"1995-06-17T11:59:29.411Z\",\n \"last_billable_usage_hour\": \"1977-01-10T18:22:34.394Z\",\n \"org_billable_usage\": 11334474,\n \"percentage_in_account\": 69600401.24401408,\n \"usage_unit\": \"irure dolore\"\n },\n \"infra_and_apm_host_top99p\": {\n \"account_billable_usage\": -99864249,\n \"account_committed_usage\": -66586916,\n \"account_on_demand_usage\": 5131732,\n \"elapsed_usage_hours\": -44462684,\n \"first_billable_usage_hour\": \"1990-11-08T22:44:12.928Z\",\n \"last_billable_usage_hour\": \"1999-04-04T16:36:13.430Z\",\n \"org_billable_usage\": -95199191,\n \"percentage_in_account\": 72670539.69450864,\n \"usage_unit\": \"proident nisi ut consequat\"\n },\n \"infra_container_sum\": {\n \"account_billable_usage\": 29592039,\n \"account_committed_usage\": -94165272,\n \"account_on_demand_usage\": -83652706,\n \"elapsed_usage_hours\": 21849027,\n \"first_billable_usage_hour\": \"1998-02-11T16:03:13.682Z\",\n \"last_billable_usage_hour\": \"2016-05-16T12:45:39.027Z\",\n \"org_billable_usage\": -965112,\n \"percentage_in_account\": 32789836.176197797,\n \"usage_unit\": \"amet sint minim\"\n },\n \"infra_host_sum\": {\n \"account_billable_usage\": -80312015,\n \"account_committed_usage\": -79984444,\n \"account_on_demand_usage\": -61367389,\n \"elapsed_usage_hours\": -6274682,\n \"first_billable_usage_hour\": \"2005-03-01T22:33:44.626Z\",\n \"last_billable_usage_hour\": \"1977-09-05T18:15:25.966Z\",\n \"org_billable_usage\": 11212075,\n \"percentage_in_account\": -34139373.21517577,\n \"usage_unit\": \"tempor dolor nulla aliqu\"\n },\n \"infra_host_top99p\": {\n \"account_billable_usage\": -98128547,\n \"account_committed_usage\": 30127568,\n \"account_on_demand_usage\": 73545911,\n \"elapsed_usage_hours\": 89459412,\n \"first_billable_usage_hour\": \"1947-11-14T22:41:24.864Z\",\n \"last_billable_usage_hour\": \"1956-11-30T14:19:21.324Z\",\n \"org_billable_usage\": 9581157,\n \"percentage_in_account\": -42525736.545791656,\n \"usage_unit\": \"cupidatat\"\n },\n \"ingested_spans_sum\": {\n \"account_billable_usage\": 64486317,\n \"account_committed_usage\": -92475147,\n \"account_on_demand_usage\": -77643280,\n \"elapsed_usage_hours\": 28536583,\n \"first_billable_usage_hour\": \"2001-11-13T00:12:27.696Z\",\n \"last_billable_usage_hour\": \"1961-11-22T11:44:45.863Z\",\n \"org_billable_usage\": 46596709,\n \"percentage_in_account\": 58967973.35446498,\n \"usage_unit\": \"ex dolor laboris id\"\n },\n \"ingested_timeseries_average\": {\n \"account_billable_usage\": -49357796,\n \"account_committed_usage\": -64820632,\n \"account_on_demand_usage\": -20197331,\n \"elapsed_usage_hours\": -28164817,\n \"first_billable_usage_hour\": \"1978-10-02T14:59:42.442Z\",\n \"last_billable_usage_hour\": \"1997-08-01T10:08:31.605Z\",\n \"org_billable_usage\": -69404602,\n \"percentage_in_account\": 67338633.44624323,\n \"usage_unit\": \"ut in velit Duis laboris\"\n },\n \"ingested_timeseries_sum\": {\n \"account_billable_usage\": 85113936,\n \"account_committed_usage\": 20667248,\n \"account_on_demand_usage\": 83422710,\n \"elapsed_usage_hours\": 70151906,\n \"first_billable_usage_hour\": \"2013-05-26T08:20:43.877Z\",\n \"last_billable_usage_hour\": \"1959-05-26T10:20:40.127Z\",\n \"org_billable_usage\": -18795661,\n \"percentage_in_account\": 79967572.59579384,\n \"usage_unit\": \"est\"\n },\n \"iot_sum\": {\n \"account_billable_usage\": 16139797,\n \"account_committed_usage\": -74236049,\n \"account_on_demand_usage\": -40856921,\n \"elapsed_usage_hours\": -34484375,\n \"first_billable_usage_hour\": \"1979-05-28T06:44:46.300Z\",\n \"last_billable_usage_hour\": \"1954-01-04T11:19:46.897Z\",\n \"org_billable_usage\": -82253055,\n \"percentage_in_account\": -79657796.80299194,\n \"usage_unit\": \"nisi eiusmod\"\n },\n \"iot_top99p\": {\n \"account_billable_usage\": 34748520,\n \"account_committed_usage\": -60142472,\n \"account_on_demand_usage\": 31566693,\n \"elapsed_usage_hours\": -98467908,\n \"first_billable_usage_hour\": \"1990-11-17T22:14:11.700Z\",\n \"last_billable_usage_hour\": \"2014-12-19T21:28:41.858Z\",\n \"org_billable_usage\": -41476634,\n \"percentage_in_account\": 79718510.49106297,\n \"usage_unit\": \"non ut dolor consectetur\"\n },\n \"lambda_function_average\": {\n \"account_billable_usage\": -12741219,\n \"account_committed_usage\": 17977768,\n \"account_on_demand_usage\": 52091139,\n \"elapsed_usage_hours\": 8122295,\n \"first_billable_usage_hour\": \"2010-11-21T01:44:54.758Z\",\n \"last_billable_usage_hour\": \"1948-01-04T16:50:28.229Z\",\n \"org_billable_usage\": 19104922,\n \"percentage_in_account\": 17878897.62403579,\n \"usage_unit\": \"sunt nulla nostrud consequat adipisicing\"\n },\n \"lambda_function_sum\": {\n \"account_billable_usage\": -13781283,\n \"account_committed_usage\": 73172800,\n \"account_on_demand_usage\": -20172266,\n \"elapsed_usage_hours\": 11300397,\n \"first_billable_usage_hour\": \"1951-12-27T09:27:16.714Z\",\n \"last_billable_usage_hour\": \"1956-06-11T23:49:08.866Z\",\n \"org_billable_usage\": -21495010,\n \"percentage_in_account\": 62862833.08948767,\n \"usage_unit\": \"ex in\"\n },\n \"logs_forwarding_sum\": {\n \"account_billable_usage\": -80067792,\n \"account_committed_usage\": -66205465,\n \"account_on_demand_usage\": -36150689,\n \"elapsed_usage_hours\": 10016985,\n \"first_billable_usage_hour\": \"1992-11-15T23:20:18.179Z\",\n \"last_billable_usage_hour\": \"1947-07-22T08:01:00.433Z\",\n \"org_billable_usage\": 142037,\n \"percentage_in_account\": -7440110.368647575,\n \"usage_unit\": \"ex irure ea\"\n },\n \"logs_indexed_15day_sum\": {\n \"account_billable_usage\": 35123275,\n \"account_committed_usage\": -64596804,\n \"account_on_demand_usage\": 20590714,\n \"elapsed_usage_hours\": -18882444,\n \"first_billable_usage_hour\": \"1958-01-08T12:54:48.669Z\",\n \"last_billable_usage_hour\": \"2011-01-07T18:59:45.008Z\",\n \"org_billable_usage\": 15431069,\n \"percentage_in_account\": 32605702.224765375,\n \"usage_unit\": \"eiusmod incididunt culpa exercitation in\"\n },\n \"logs_indexed_180day_sum\": {\n \"account_billable_usage\": 98023228,\n \"account_committed_usage\": -75120015,\n \"account_on_demand_usage\": -14566021,\n \"elapsed_usage_hours\": -79643578,\n \"first_billable_usage_hour\": \"1977-05-06T17:40:09.332Z\",\n \"last_billable_usage_hour\": \"2009-10-16T10:42:08.705Z\",\n \"org_billable_usage\": -34904935,\n \"percentage_in_account\": -79095105.20682248,\n \"usage_unit\": \"ut dolore veniam\"\n },\n \"logs_indexed_1day_sum\": {\n \"account_billable_usage\": -10632834,\n \"account_committed_usage\": 13905667,\n \"account_on_demand_usage\": -79932024,\n \"elapsed_usage_hours\": -9963961,\n \"first_billable_usage_hour\": \"1976-04-04T17:35:05.552Z\",\n \"last_billable_usage_hour\": \"1997-06-02T11:54:24.283Z\",\n \"org_billable_usage\": 29192024,\n \"percentage_in_account\": 80404677.50801113,\n \"usage_unit\": \"consectetur qui deserunt laborum labore\"\n },\n \"logs_indexed_30day_sum\": {\n \"account_billable_usage\": -16972278,\n \"account_committed_usage\": 71519188,\n \"account_on_demand_usage\": -46654558,\n \"elapsed_usage_hours\": 31359427,\n \"first_billable_usage_hour\": \"2004-10-12T17:40:22.288Z\",\n \"last_billable_usage_hour\": \"1947-07-08T05:40:58.021Z\",\n \"org_billable_usage\": 53251049,\n \"percentage_in_account\": -3165297.807175249,\n \"usage_unit\": \"dolore eiusmod dolor\"\n },\n \"logs_indexed_360day_sum\": {\n \"account_billable_usage\": -91503762,\n \"account_committed_usage\": -13038241,\n \"account_on_demand_usage\": -50869035,\n \"elapsed_usage_hours\": 45035450,\n \"first_billable_usage_hour\": \"1979-10-07T23:35:37.265Z\",\n \"last_billable_usage_hour\": \"1997-11-11T17:40:52.843Z\",\n \"org_billable_usage\": -51187388,\n \"percentage_in_account\": 70944600.83846694,\n \"usage_unit\": \"culpa velit fugiat\"\n },\n \"logs_indexed_3day_sum\": {\n \"account_billable_usage\": 54166999,\n \"account_committed_usage\": 23568570,\n \"account_on_demand_usage\": -53015248,\n \"elapsed_usage_hours\": 55611952,\n \"first_billable_usage_hour\": \"1967-09-02T01:53:34.277Z\",\n \"last_billable_usage_hour\": \"1994-12-28T08:45:52.922Z\",\n \"org_billable_usage\": 10469077,\n \"percentage_in_account\": 83132381.40910238,\n \"usage_unit\": \"qui commodo\"\n },\n \"logs_indexed_45day_sum\": {\n \"account_billable_usage\": 23896229,\n \"account_committed_usage\": -27141113,\n \"account_on_demand_usage\": -73108019,\n \"elapsed_usage_hours\": -78850578,\n \"first_billable_usage_hour\": \"2024-07-16T22:12:26.863Z\",\n \"last_billable_usage_hour\": \"1990-08-05T08:23:30.924Z\",\n \"org_billable_usage\": -51461583,\n \"percentage_in_account\": 39727776.812229574,\n \"usage_unit\": \"dolore nisi ullamco dolor\"\n },\n \"logs_indexed_60day_sum\": {\n \"account_billable_usage\": 35154847,\n \"account_committed_usage\": -54042151,\n \"account_on_demand_usage\": -29182661,\n \"elapsed_usage_hours\": 62901361,\n \"first_billable_usage_hour\": \"2015-10-04T09:34:25.786Z\",\n \"last_billable_usage_hour\": \"2008-01-24T13:39:47.809Z\",\n \"org_billable_usage\": 23755679,\n \"percentage_in_account\": 36271936.78288302,\n \"usage_unit\": \"anim in eu\"\n },\n \"logs_indexed_7day_sum\": {\n \"account_billable_usage\": -17271157,\n \"account_committed_usage\": 38515472,\n \"account_on_demand_usage\": -22139350,\n \"elapsed_usage_hours\": 74946759,\n \"first_billable_usage_hour\": \"1975-09-20T22:37:36.203Z\",\n \"last_billable_usage_hour\": \"1961-06-01T09:19:30.061Z\",\n \"org_billable_usage\": -40945648,\n \"percentage_in_account\": -25073589.044990957,\n \"usage_unit\": \"dolor m\"\n },\n \"logs_indexed_90day_sum\": {\n \"account_billable_usage\": -22047590,\n \"account_committed_usage\": -74098043,\n \"account_on_demand_usage\": -29483055,\n \"elapsed_usage_hours\": 393971,\n \"first_billable_usage_hour\": \"1971-12-12T22:34:17.736Z\",\n \"last_billable_usage_hour\": \"1964-05-12T20:16:21.705Z\",\n \"org_billable_usage\": 50246449,\n \"percentage_in_account\": -96941341.48540734,\n \"usage_unit\": \"ad adipisicing cillum reprehenderit nostrud\"\n },\n \"logs_indexed_custom_retention_sum\": {\n \"account_billable_usage\": 74929612,\n \"account_committed_usage\": 58702209,\n \"account_on_demand_usage\": -60523795,\n \"elapsed_usage_hours\": 2805632,\n \"first_billable_usage_hour\": \"2013-11-10T03:55:16.736Z\",\n \"last_billable_usage_hour\": \"1983-11-26T22:10:46.693Z\",\n \"org_billable_usage\": 97842529,\n \"percentage_in_account\": 19653703.368709043,\n \"usage_unit\": \"proident in\"\n },\n \"logs_indexed_sum\": {\n \"account_billable_usage\": -73961464,\n \"account_committed_usage\": -88174828,\n \"account_on_demand_usage\": 455275,\n \"elapsed_usage_hours\": 57758462,\n \"first_billable_usage_hour\": \"1986-05-05T07:33:56.794Z\",\n \"last_billable_usage_hour\": \"2003-02-03T12:59:05.960Z\",\n \"org_billable_usage\": -50039452,\n \"percentage_in_account\": 5850821.18155846,\n \"usage_unit\": \"offici\"\n },\n \"logs_ingested_sum\": {\n \"account_billable_usage\": -67187692,\n \"account_committed_usage\": 49951216,\n \"account_on_demand_usage\": 61557613,\n \"elapsed_usage_hours\": 49833202,\n \"first_billable_usage_hour\": \"1960-10-04T15:49:58.626Z\",\n \"last_billable_usage_hour\": \"2013-12-11T03:09:27.850Z\",\n \"org_billable_usage\": 87837621,\n \"percentage_in_account\": -55820624.08562387,\n \"usage_unit\": \"mollit tempor Lorem aliqua\"\n },\n \"network_device_sum\": {\n \"account_billable_usage\": 79632642,\n \"account_committed_usage\": 74134913,\n \"account_on_demand_usage\": 27850825,\n \"elapsed_usage_hours\": 50316559,\n \"first_billable_usage_hour\": \"2016-12-08T15:29:46.599Z\",\n \"last_billable_usage_hour\": \"2013-10-19T10:41:17.700Z\",\n \"org_billable_usage\": -39056975,\n \"percentage_in_account\": -11877668.473595262,\n \"usage_unit\": \"eiusmod deserunt in\"\n },\n \"network_device_top99p\": {\n \"account_billable_usage\": 46270145,\n \"account_committed_usage\": -21601541,\n \"account_on_demand_usage\": -2564841,\n \"elapsed_usage_hours\": 77995696,\n \"first_billable_usage_hour\": \"1973-10-15T23:40:25.032Z\",\n \"last_billable_usage_hour\": \"1978-03-06T00:11:22.745Z\",\n \"org_billable_usage\": -7745366,\n \"percentage_in_account\": -1497922.5231433809,\n \"usage_unit\": \"veniam dolore elit\"\n },\n \"npm_flow_sum\": {\n \"account_billable_usage\": -66613846,\n \"account_committed_usage\": -27952445,\n \"account_on_demand_usage\": -33082425,\n \"elapsed_usage_hours\": -89073200,\n \"first_billable_usage_hour\": \"1954-03-29T02:17:18.636Z\",\n \"last_billable_usage_hour\": \"1985-09-03T00:24:48.855Z\",\n \"org_billable_usage\": -64372187,\n \"percentage_in_account\": 99514481.4187297,\n \"usage_unit\": \"non eiusmod enim aliquip dolore\"\n },\n \"npm_host_sum\": {\n \"account_billable_usage\": -94324213,\n \"account_committed_usage\": -68666036,\n \"account_on_demand_usage\": 85160829,\n \"elapsed_usage_hours\": 87011649,\n \"first_billable_usage_hour\": \"1952-08-10T08:59:20.081Z\",\n \"last_billable_usage_hour\": \"2011-05-31T10:46:35.185Z\",\n \"org_billable_usage\": -97974185,\n \"percentage_in_account\": -94886689.24459036,\n \"usage_unit\": \"ipsum reprehenderit consequat\"\n },\n \"npm_host_top99p\": {\n \"account_billable_usage\": 26098163,\n \"account_committed_usage\": 56496863,\n \"account_on_demand_usage\": 19684990,\n \"elapsed_usage_hours\": -53931228,\n \"first_billable_usage_hour\": \"1972-05-30T18:58:49.356Z\",\n \"last_billable_usage_hour\": \"1983-09-11T18:12:12.803Z\",\n \"org_billable_usage\": 21247632,\n \"percentage_in_account\": 47810712.479750186,\n \"usage_unit\": \"quis esse\"\n },\n \"observability_pipeline_sum\": {\n \"account_billable_usage\": -56632301,\n \"account_committed_usage\": -86222719,\n \"account_on_demand_usage\": 45032653,\n \"elapsed_usage_hours\": 1369334,\n \"first_billable_usage_hour\": \"2011-12-11T23:55:16.081Z\",\n \"last_billable_usage_hour\": \"1987-04-10T15:32:39.629Z\",\n \"org_billable_usage\": 82008062,\n \"percentage_in_account\": -86294271.76154542,\n \"usage_unit\": \"esse dolor ipsum eu eiusmod\"\n },\n \"online_archive_sum\": {\n \"account_billable_usage\": 74070879,\n \"account_committed_usage\": 70887177,\n \"account_on_demand_usage\": -62580700,\n \"elapsed_usage_hours\": -7618380,\n \"first_billable_usage_hour\": \"2020-11-25T16:36:22.852Z\",\n \"last_billable_usage_hour\": \"2015-06-04T14:13:14.586Z\",\n \"org_billable_usage\": -43796052,\n \"percentage_in_account\": 90436877.5116038,\n \"usage_unit\": \"ea consectetur\"\n },\n \"prof_container_sum\": {\n \"account_billable_usage\": -9312967,\n \"account_committed_usage\": 33141646,\n \"account_on_demand_usage\": 97871623,\n \"elapsed_usage_hours\": -45045681,\n \"first_billable_usage_hour\": \"1950-02-05T18:24:50.141Z\",\n \"last_billable_usage_hour\": \"2020-07-19T10:38:09.457Z\",\n \"org_billable_usage\": -30349057,\n \"percentage_in_account\": -48367961.848685056,\n \"usage_unit\": \"adipisicing \"\n },\n \"prof_host_sum\": {\n \"account_billable_usage\": 26241447,\n \"account_committed_usage\": 59194870,\n \"account_on_demand_usage\": -65575690,\n \"elapsed_usage_hours\": -15366827,\n \"first_billable_usage_hour\": \"1958-02-26T16:59:55.939Z\",\n \"last_billable_usage_hour\": \"2007-02-10T04:45:07.940Z\",\n \"org_billable_usage\": -49295078,\n \"percentage_in_account\": -69760336.21421163,\n \"usage_unit\": \"eiusmod cillum\"\n },\n \"prof_host_top99p\": {\n \"account_billable_usage\": -22418890,\n \"account_committed_usage\": 27905306,\n \"account_on_demand_usage\": -11426737,\n \"elapsed_usage_hours\": -34273621,\n \"first_billable_usage_hour\": \"1961-11-30T04:31:50.684Z\",\n \"last_billable_usage_hour\": \"2024-10-18T03:42:41.871Z\",\n \"org_billable_usage\": -1042039,\n \"percentage_in_account\": 85568600.29651576,\n \"usage_unit\": \"aliqua qui eiusmod\"\n },\n \"rum_lite_sum\": {\n \"account_billable_usage\": 72008559,\n \"account_committed_usage\": -24582864,\n \"account_on_demand_usage\": -8149581,\n \"elapsed_usage_hours\": -76820181,\n \"first_billable_usage_hour\": \"2011-06-24T01:43:44.516Z\",\n \"last_billable_usage_hour\": \"2019-01-07T13:29:14.079Z\",\n \"org_billable_usage\": 29951553,\n \"percentage_in_account\": -38270805.05321357,\n \"usage_unit\": \"dolore ipsum\"\n },\n \"rum_replay_sum\": {\n \"account_billable_usage\": -50308841,\n \"account_committed_usage\": 82365099,\n \"account_on_demand_usage\": 89108739,\n \"elapsed_usage_hours\": -76335427,\n \"first_billable_usage_hour\": \"1976-03-27T05:44:51.129Z\",\n \"last_billable_usage_hour\": \"2009-11-07T02:48:01.126Z\",\n \"org_billable_usage\": 67796627,\n \"percentage_in_account\": -45116960.04038117,\n \"usage_unit\": \"eu fugiat quis nostrud\"\n },\n \"rum_sum\": {\n \"account_billable_usage\": -57161451,\n \"account_committed_usage\": -48268507,\n \"account_on_demand_usage\": -95387841,\n \"elapsed_usage_hours\": -22405016,\n \"first_billable_usage_hour\": \"2006-06-28T00:34:01.242Z\",\n \"last_billable_usage_hour\": \"1962-05-18T13:59:40.851Z\",\n \"org_billable_usage\": -25967979,\n \"percentage_in_account\": 80584585.45776495,\n \"usage_unit\": \"sed tempor\"\n },\n \"rum_units_sum\": {\n \"account_billable_usage\": 73632078,\n \"account_committed_usage\": 10396123,\n \"account_on_demand_usage\": 70986018,\n \"elapsed_usage_hours\": 2667339,\n \"first_billable_usage_hour\": \"1951-05-17T09:51:16.413Z\",\n \"last_billable_usage_hour\": \"2022-03-18T14:25:02.218Z\",\n \"org_billable_usage\": -54081313,\n \"percentage_in_account\": 84308694.67669919,\n \"usage_unit\": \"ut dolore eiu\"\n },\n \"sensitive_data_scanner_sum\": {\n \"account_billable_usage\": -38370202,\n \"account_committed_usage\": -78775984,\n \"account_on_demand_usage\": 16621299,\n \"elapsed_usage_hours\": -44233259,\n \"first_billable_usage_hour\": \"1973-04-29T00:35:14.702Z\",\n \"last_billable_usage_hour\": \"1951-04-06T00:53:05.854Z\",\n \"org_billable_usage\": -33279085,\n \"percentage_in_account\": -56481911.45176862,\n \"usage_unit\": \"mollit non velit\"\n },\n \"serverless_apm_sum\": {\n \"account_billable_usage\": -98886624,\n \"account_committed_usage\": 5910812,\n \"account_on_demand_usage\": 38842539,\n \"elapsed_usage_hours\": -75220697,\n \"first_billable_usage_hour\": \"2004-03-06T05:33:46.657Z\",\n \"last_billable_usage_hour\": \"1994-10-14T23:24:02.637Z\",\n \"org_billable_usage\": -27163312,\n \"percentage_in_account\": 26785860.844915077,\n \"usage_unit\": \"dolore dolor\"\n },\n \"serverless_infra_average\": {\n \"account_billable_usage\": -8926637,\n \"account_committed_usage\": 21577932,\n \"account_on_demand_usage\": -50249643,\n \"elapsed_usage_hours\": -62229694,\n \"first_billable_usage_hour\": \"1999-06-08T07:39:58.932Z\",\n \"last_billable_usage_hour\": \"1999-06-08T08:06:34.693Z\",\n \"org_billable_usage\": -25875619,\n \"percentage_in_account\": -95858385.40990806,\n \"usage_unit\": \"pariatur incididunt Excepteur occaecat\"\n },\n \"serverless_infra_sum\": {\n \"account_billable_usage\": 62449697,\n \"account_committed_usage\": -97547591,\n \"account_on_demand_usage\": 46278755,\n \"elapsed_usage_hours\": 1550951,\n \"first_billable_usage_hour\": \"1995-03-03T08:22:11.603Z\",\n \"last_billable_usage_hour\": \"1979-01-03T07:03:45.859Z\",\n \"org_billable_usage\": -86905769,\n \"percentage_in_account\": -34174009.27980172,\n \"usage_unit\": \"Ut exercitation velit elit\"\n },\n \"serverless_invocation_sum\": {\n \"account_billable_usage\": 52107351,\n \"account_committed_usage\": 57860433,\n \"account_on_demand_usage\": -68641213,\n \"elapsed_usage_hours\": -19829236,\n \"first_billable_usage_hour\": \"2015-02-06T20:12:14.234Z\",\n \"last_billable_usage_hour\": \"1952-08-06T21:49:51.079Z\",\n \"org_billable_usage\": 79674928,\n \"percentage_in_account\": -17024890.378925577,\n \"usage_unit\": \"sit id sed\"\n },\n \"siem_sum\": {\n \"account_billable_usage\": -29530724,\n \"account_committed_usage\": 61907080,\n \"account_on_demand_usage\": 30449721,\n \"elapsed_usage_hours\": 36331563,\n \"first_billable_usage_hour\": \"2016-01-12T19:37:58.658Z\",\n \"last_billable_usage_hour\": \"1967-12-05T11:52:42.070Z\",\n \"org_billable_usage\": -12555086,\n \"percentage_in_account\": -60173523.03428454,\n \"usage_unit\": \"fugiat laboris do\"\n },\n \"standard_timeseries_average\": {\n \"account_billable_usage\": 68242545,\n \"account_committed_usage\": -23570363,\n \"account_on_demand_usage\": 4264532,\n \"elapsed_usage_hours\": -10873815,\n \"first_billable_usage_hour\": \"1966-09-16T01:45:44.676Z\",\n \"last_billable_usage_hour\": \"1996-03-18T13:00:19.936Z\",\n \"org_billable_usage\": -46954686,\n \"percentage_in_account\": 14970545.11013493,\n \"usage_unit\": \"sunt aliquip Lorem\"\n },\n \"synthetics_api_tests_sum\": {\n \"account_billable_usage\": 70565532,\n \"account_committed_usage\": 93566974,\n \"account_on_demand_usage\": -15822730,\n \"elapsed_usage_hours\": -69512398,\n \"first_billable_usage_hour\": \"1993-12-09T00:09:48.236Z\",\n \"last_billable_usage_hour\": \"1988-05-04T07:46:36.079Z\",\n \"org_billable_usage\": 10078322,\n \"percentage_in_account\": -20051.378753229976,\n \"usage_unit\": \"do nisi incididunt\"\n },\n \"synthetics_app_testing_maximum\": {\n \"account_billable_usage\": 93792683,\n \"account_committed_usage\": 29806951,\n \"account_on_demand_usage\": 83717224,\n \"elapsed_usage_hours\": -77034579,\n \"first_billable_usage_hour\": \"1948-04-04T15:09:31.815Z\",\n \"last_billable_usage_hour\": \"1997-02-13T18:16:57.029Z\",\n \"org_billable_usage\": 81368175,\n \"percentage_in_account\": -41161581.27123233,\n \"usage_unit\": \"qui quis\"\n },\n \"synthetics_browser_checks_sum\": {\n \"account_billable_usage\": -2468355,\n \"account_committed_usage\": 63681025,\n \"account_on_demand_usage\": 73388290,\n \"elapsed_usage_hours\": -62266319,\n \"first_billable_usage_hour\": \"2012-11-10T11:24:35.213Z\",\n \"last_billable_usage_hour\": \"2020-04-21T01:26:24.884Z\",\n \"org_billable_usage\": 68367365,\n \"percentage_in_account\": -27905952.89787315,\n \"usage_unit\": \"incididunt ut nisi\"\n },\n \"timeseries_average\": {\n \"account_billable_usage\": 45425744,\n \"account_committed_usage\": -27160244,\n \"account_on_demand_usage\": -11788701,\n \"elapsed_usage_hours\": -41111836,\n \"first_billable_usage_hour\": \"2013-12-07T02:36:56.462Z\",\n \"last_billable_usage_hour\": \"1977-04-22T09:17:08.609Z\",\n \"org_billable_usage\": 79649926,\n \"percentage_in_account\": 59730688.050002545,\n \"usage_unit\": \"reprehenderit laborum qui dolore\"\n },\n \"timeseries_sum\": {\n \"account_billable_usage\": 67459754,\n \"account_committed_usage\": 46376564,\n \"account_on_demand_usage\": 69463660,\n \"elapsed_usage_hours\": -93075986,\n \"first_billable_usage_hour\": \"1983-02-05T13:08:52.220Z\",\n \"last_billable_usage_hour\": \"1959-05-05T18:15:55.800Z\",\n \"org_billable_usage\": -90711915,\n \"percentage_in_account\": 43152595.40087637,\n \"usage_unit\": \"ullamco Duis pariatur\"\n }\n }\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/billable-summary?month=1993-10-23T16:56:47.315Z&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"billable-summary"
],
"query": [
{
"key": "month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden - User is not authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/billable-summary?month=1993-10-23T16:56:47.315Z&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"billable-summary"
],
"query": [
{
"key": "month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/billable-summary?month=1993-10-23T16:56:47.315Z&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"billable-summary"
],
"query": [
{
"key": "month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get historical cost across your account",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/historical_cost?start_month=2009-09-16T14:43:51.288Z&view=consectetur consequat dolor&end_month=2009-09-16T14:43:51.288Z&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"historical_cost"
],
"query": [
{
"key": "start_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month."
},
{
"key": "view",
"value": "consectetur consequat dolor",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"key": "end_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
},
"description": "Get historical cost across multi-org and single root-org accounts.\nCost data for a given month becomes available no later than the 16th of the following month.\n\nThis endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/historical_cost?start_month=2009-09-16T14:43:51.288Z&view=consectetur consequat dolor&end_month=2009-09-16T14:43:51.288Z&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"historical_cost"
],
"query": [
{
"key": "start_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month."
},
{
"key": "view",
"value": "consectetur consequat dolor",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"key": "end_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"account_name\": \"ex\",\n \"account_public_id\": \"nisi ipsum aute\",\n \"charges\": [\n {\n \"charge_type\": \"on_demand\",\n \"cost\": -64159446.79985919,\n \"product_name\": \"infra_host\"\n },\n {\n \"charge_type\": \"on_demand\",\n \"cost\": 49261497.248108804,\n \"product_name\": \"infra_host\"\n }\n ],\n \"date\": \"1985-12-30T14:27:46.895Z\",\n \"org_name\": \"ut sed minim aliquip cupidatat\",\n \"public_id\": \"ea elit nostrud\",\n \"region\": \"nulla labore sit\",\n \"total_cost\": -36381845.340580754\n },\n \"id\": \"velit\",\n \"type\": \"cost_by_org\"\n },\n {\n \"attributes\": {\n \"account_name\": \"sit ut elit quis\",\n \"account_public_id\": \"exercitation minim laboris et\",\n \"charges\": [\n {\n \"charge_type\": \"on_demand\",\n \"cost\": 8235400.667606398,\n \"product_name\": \"infra_host\"\n },\n {\n \"charge_type\": \"on_demand\",\n \"cost\": 23931878.86286345,\n \"product_name\": \"infra_host\"\n }\n ],\n \"date\": \"2009-09-24T19:46:05.610Z\",\n \"org_name\": \"cupidatat\",\n \"public_id\": \"sunt qui anim labore occaecat\",\n \"region\": \"consectetur\",\n \"total_cost\": -47542931.51800091\n },\n \"id\": \"non dolor id\",\n \"type\": \"cost_by_org\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/historical_cost?start_month=2009-09-16T14:43:51.288Z&view=consectetur consequat dolor&end_month=2009-09-16T14:43:51.288Z&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"historical_cost"
],
"query": [
{
"key": "start_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month."
},
{
"key": "view",
"value": "consectetur consequat dolor",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"key": "end_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden - User is not authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/historical_cost?start_month=2009-09-16T14:43:51.288Z&view=consectetur consequat dolor&end_month=2009-09-16T14:43:51.288Z&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"historical_cost"
],
"query": [
{
"key": "start_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month."
},
{
"key": "view",
"value": "consectetur consequat dolor",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"key": "end_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/historical_cost?start_month=2009-09-16T14:43:51.288Z&view=consectetur consequat dolor&end_month=2009-09-16T14:43:51.288Z&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"historical_cost"
],
"query": [
{
"key": "start_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month."
},
{
"key": "view",
"value": "consectetur consequat dolor",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"key": "end_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get Monthly Cost Attribution",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost_by_tag/monthly_cost_attribution?start_month=2009-09-16T14:43:51.288Z&end_month=2009-09-16T14:43:51.288Z&fields=consectetur consequat dolor&sort_direction=desc&sort_name=consectetur consequat dolor&tag_breakdown_keys=consectetur consequat dolor&next_record_id=consectetur consequat dolor&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost_by_tag",
"monthly_cost_attribution"
],
"query": [
{
"key": "start_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning in this month."
},
{
"key": "end_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
},
{
"key": "fields",
"value": "consectetur consequat dolor",
"description": "(Required) Comma-separated list specifying cost types (e.g., `<billing_dimension>_on_demand_cost`, `<billing_dimension>_committed_cost`, `<billing_dimension>_total_cost`) and the\nproportions (`<billing_dimension>_percentage_in_org`, `<billing_dimension>_percentage_in_account`). Use `*` to retrieve all fields.\nExample: `infra_host_on_demand_cost,infra_host_percentage_in_account`\nTo obtain the complete list of active billing dimensions that can be used to replace\n`<billing_dimension>` in the field names, make a request to the [Get active billing dimensions API](https://docs.datadoghq.com/api/latest/usage-metering/#get-active-billing-dimensions-for-cost-attribution)."
},
{
"key": "sort_direction",
"value": "desc",
"description": "The direction to sort by: `[desc, asc]`."
},
{
"key": "sort_name",
"value": "consectetur consequat dolor",
"description": "The billing dimension to sort by. Always sorted by total cost. Example: `infra_host`."
},
{
"key": "tag_breakdown_keys",
"value": "consectetur consequat dolor",
"description": "Comma separated list of tag keys used to group cost. If no value is provided the cost will not be broken down by tags.\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "next_record_id",
"value": "consectetur consequat dolor",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org cost in the response. Defaults to `true`."
}
]
},
"description": "Get monthly cost attribution by tag across multi-org and single root-org accounts.\nCost Attribution data for a given month becomes available no later than the 19th of the following month.\nThis API endpoint is paginated. To make sure you receive all records, check if the value of `next_record_id` is\nset in the response. If it is, make another request and pass `next_record_id` as a parameter.\nPseudo code example:\n```\nresponse := GetMonthlyCostAttribution(start_month, end_month)\ncursor := response.metadata.pagination.next_record_id\nWHILE cursor != null BEGIN\n sleep(5 seconds) # Avoid running into rate limit\n response := GetMonthlyCostAttribution(start_month, end_month, next_record_id=cursor)\n cursor := response.metadata.pagination.next_record_id\nEND\n```\n\nThis endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). This endpoint is not available in the Government (US1-FED) site."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost_by_tag/monthly_cost_attribution?start_month=2009-09-16T14:43:51.288Z&end_month=2009-09-16T14:43:51.288Z&fields=consectetur consequat dolor&sort_direction=desc&sort_name=consectetur consequat dolor&tag_breakdown_keys=consectetur consequat dolor&next_record_id=consectetur consequat dolor&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost_by_tag",
"monthly_cost_attribution"
],
"query": [
{
"key": "start_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning in this month."
},
{
"key": "end_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
},
{
"key": "fields",
"value": "consectetur consequat dolor",
"description": "(Required) Comma-separated list specifying cost types (e.g., `<billing_dimension>_on_demand_cost`, `<billing_dimension>_committed_cost`, `<billing_dimension>_total_cost`) and the\nproportions (`<billing_dimension>_percentage_in_org`, `<billing_dimension>_percentage_in_account`). Use `*` to retrieve all fields.\nExample: `infra_host_on_demand_cost,infra_host_percentage_in_account`\nTo obtain the complete list of active billing dimensions that can be used to replace\n`<billing_dimension>` in the field names, make a request to the [Get active billing dimensions API](https://docs.datadoghq.com/api/latest/usage-metering/#get-active-billing-dimensions-for-cost-attribution)."
},
{
"key": "sort_direction",
"value": "desc",
"description": "The direction to sort by: `[desc, asc]`."
},
{
"key": "sort_name",
"value": "consectetur consequat dolor",
"description": "The billing dimension to sort by. Always sorted by total cost. Example: `infra_host`."
},
{
"key": "tag_breakdown_keys",
"value": "consectetur consequat dolor",
"description": "Comma separated list of tag keys used to group cost. If no value is provided the cost will not be broken down by tags.\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "next_record_id",
"value": "consectetur consequat dolor",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org cost in the response. Defaults to `true`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"month\": \"2001-10-06T10:49:23.547Z\",\n \"org_name\": \"commodo\",\n \"public_id\": \"nulla adipisicing nostrud\",\n \"tag_config_source\": \"ad anim Excepteur cupidatat\",\n \"tags\": {\n \"irure1\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ],\n \"laboris_f5\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ]\n },\n \"updated_at\": \"mollit consectetur\",\n \"values\": {}\n },\n \"id\": \"ullamco\",\n \"type\": \"cost_by_tag\"\n },\n {\n \"attributes\": {\n \"month\": \"1994-09-04T22:05:09.186Z\",\n \"org_name\": \"nulla exercitation laborum culpa incididunt\",\n \"public_id\": \"officia Ut sed consequat\",\n \"tag_config_source\": \"incididu\",\n \"tags\": {\n \"tempor6b5\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ],\n \"incididuntd\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ]\n },\n \"updated_at\": \"in exercitation sit amet non\",\n \"values\": {}\n },\n \"id\": \"quis cupidatat\",\n \"type\": \"cost_by_tag\"\n }\n ],\n \"meta\": {\n \"aggregates\": [\n {\n \"agg_type\": \"sum\",\n \"field\": \"infra_host_committed_cost\",\n \"value\": -77314836.09077832\n },\n {\n \"agg_type\": \"sum\",\n \"field\": \"infra_host_committed_cost\",\n \"value\": 67590727.13289124\n }\n ],\n \"pagination\": {\n \"next_record_id\": \"laboris elit\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost_by_tag/monthly_cost_attribution?start_month=2009-09-16T14:43:51.288Z&end_month=2009-09-16T14:43:51.288Z&fields=consectetur consequat dolor&sort_direction=desc&sort_name=consectetur consequat dolor&tag_breakdown_keys=consectetur consequat dolor&next_record_id=consectetur consequat dolor&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost_by_tag",
"monthly_cost_attribution"
],
"query": [
{
"key": "start_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning in this month."
},
{
"key": "end_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
},
{
"key": "fields",
"value": "consectetur consequat dolor",
"description": "(Required) Comma-separated list specifying cost types (e.g., `<billing_dimension>_on_demand_cost`, `<billing_dimension>_committed_cost`, `<billing_dimension>_total_cost`) and the\nproportions (`<billing_dimension>_percentage_in_org`, `<billing_dimension>_percentage_in_account`). Use `*` to retrieve all fields.\nExample: `infra_host_on_demand_cost,infra_host_percentage_in_account`\nTo obtain the complete list of active billing dimensions that can be used to replace\n`<billing_dimension>` in the field names, make a request to the [Get active billing dimensions API](https://docs.datadoghq.com/api/latest/usage-metering/#get-active-billing-dimensions-for-cost-attribution)."
},
{
"key": "sort_direction",
"value": "desc",
"description": "The direction to sort by: `[desc, asc]`."
},
{
"key": "sort_name",
"value": "consectetur consequat dolor",
"description": "The billing dimension to sort by. Always sorted by total cost. Example: `infra_host`."
},
{
"key": "tag_breakdown_keys",
"value": "consectetur consequat dolor",
"description": "Comma separated list of tag keys used to group cost. If no value is provided the cost will not be broken down by tags.\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "next_record_id",
"value": "consectetur consequat dolor",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org cost in the response. Defaults to `true`."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden - User is not authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost_by_tag/monthly_cost_attribution?start_month=2009-09-16T14:43:51.288Z&end_month=2009-09-16T14:43:51.288Z&fields=consectetur consequat dolor&sort_direction=desc&sort_name=consectetur consequat dolor&tag_breakdown_keys=consectetur consequat dolor&next_record_id=consectetur consequat dolor&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost_by_tag",
"monthly_cost_attribution"
],
"query": [
{
"key": "start_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning in this month."
},
{
"key": "end_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
},
{
"key": "fields",
"value": "consectetur consequat dolor",
"description": "(Required) Comma-separated list specifying cost types (e.g., `<billing_dimension>_on_demand_cost`, `<billing_dimension>_committed_cost`, `<billing_dimension>_total_cost`) and the\nproportions (`<billing_dimension>_percentage_in_org`, `<billing_dimension>_percentage_in_account`). Use `*` to retrieve all fields.\nExample: `infra_host_on_demand_cost,infra_host_percentage_in_account`\nTo obtain the complete list of active billing dimensions that can be used to replace\n`<billing_dimension>` in the field names, make a request to the [Get active billing dimensions API](https://docs.datadoghq.com/api/latest/usage-metering/#get-active-billing-dimensions-for-cost-attribution)."
},
{
"key": "sort_direction",
"value": "desc",
"description": "The direction to sort by: `[desc, asc]`."
},
{
"key": "sort_name",
"value": "consectetur consequat dolor",
"description": "The billing dimension to sort by. Always sorted by total cost. Example: `infra_host`."
},
{
"key": "tag_breakdown_keys",
"value": "consectetur consequat dolor",
"description": "Comma separated list of tag keys used to group cost. If no value is provided the cost will not be broken down by tags.\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "next_record_id",
"value": "consectetur consequat dolor",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org cost in the response. Defaults to `true`."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/cost_by_tag/monthly_cost_attribution?start_month=2009-09-16T14:43:51.288Z&end_month=2009-09-16T14:43:51.288Z&fields=consectetur consequat dolor&sort_direction=desc&sort_name=consectetur consequat dolor&tag_breakdown_keys=consectetur consequat dolor&next_record_id=consectetur consequat dolor&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"cost_by_tag",
"monthly_cost_attribution"
],
"query": [
{
"key": "start_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning in this month."
},
{
"key": "end_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
},
{
"key": "fields",
"value": "consectetur consequat dolor",
"description": "(Required) Comma-separated list specifying cost types (e.g., `<billing_dimension>_on_demand_cost`, `<billing_dimension>_committed_cost`, `<billing_dimension>_total_cost`) and the\nproportions (`<billing_dimension>_percentage_in_org`, `<billing_dimension>_percentage_in_account`). Use `*` to retrieve all fields.\nExample: `infra_host_on_demand_cost,infra_host_percentage_in_account`\nTo obtain the complete list of active billing dimensions that can be used to replace\n`<billing_dimension>` in the field names, make a request to the [Get active billing dimensions API](https://docs.datadoghq.com/api/latest/usage-metering/#get-active-billing-dimensions-for-cost-attribution)."
},
{
"key": "sort_direction",
"value": "desc",
"description": "The direction to sort by: `[desc, asc]`."
},
{
"key": "sort_name",
"value": "consectetur consequat dolor",
"description": "The billing dimension to sort by. Always sorted by total cost. Example: `infra_host`."
},
{
"key": "tag_breakdown_keys",
"value": "consectetur consequat dolor",
"description": "Comma separated list of tag keys used to group cost. If no value is provided the cost will not be broken down by tags.\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "next_record_id",
"value": "consectetur consequat dolor",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org cost in the response. Defaults to `true`."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get estimated cost across your account",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/estimated_cost?view=consectetur consequat dolor&start_month=2009-09-16T14:43:51.288Z&end_month=2009-09-16T14:43:51.288Z&start_date=2009-09-16T14:43:51.288Z&end_date=2009-09-16T14:43:51.288Z&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"estimated_cost"
],
"query": [
{
"key": "view",
"value": "consectetur consequat dolor",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"key": "start_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month. **Either start_month or start_date should be specified, but not both.** (start_month cannot go beyond two months in the past). Provide an `end_month` to view month-over-month cost."
},
{
"key": "end_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
},
{
"key": "start_date",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` for cost beginning this day. **Either start_month or start_date should be specified, but not both.** (start_date cannot go beyond two months in the past). Provide an `end_date` to view day-over-day cumulative cost."
},
{
"key": "end_date",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` for cost ending this day."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
},
"description": "Get estimated cost across multi-org and single root-org accounts.\nEstimated cost data is only available for the current month and previous month\nand is delayed by up to 72 hours from when it was incurred.\nTo access historical costs prior to this, use the `/historical_cost` endpoint.\n\nThis endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/estimated_cost?view=consectetur consequat dolor&start_month=2009-09-16T14:43:51.288Z&end_month=2009-09-16T14:43:51.288Z&start_date=2009-09-16T14:43:51.288Z&end_date=2009-09-16T14:43:51.288Z&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"estimated_cost"
],
"query": [
{
"key": "view",
"value": "consectetur consequat dolor",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"key": "start_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month. **Either start_month or start_date should be specified, but not both.** (start_month cannot go beyond two months in the past). Provide an `end_month` to view month-over-month cost."
},
{
"key": "end_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
},
{
"key": "start_date",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` for cost beginning this day. **Either start_month or start_date should be specified, but not both.** (start_date cannot go beyond two months in the past). Provide an `end_date` to view day-over-day cumulative cost."
},
{
"key": "end_date",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` for cost ending this day."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"account_name\": \"ex\",\n \"account_public_id\": \"nisi ipsum aute\",\n \"charges\": [\n {\n \"charge_type\": \"on_demand\",\n \"cost\": -64159446.79985919,\n \"product_name\": \"infra_host\"\n },\n {\n \"charge_type\": \"on_demand\",\n \"cost\": 49261497.248108804,\n \"product_name\": \"infra_host\"\n }\n ],\n \"date\": \"1985-12-30T14:27:46.895Z\",\n \"org_name\": \"ut sed minim aliquip cupidatat\",\n \"public_id\": \"ea elit nostrud\",\n \"region\": \"nulla labore sit\",\n \"total_cost\": -36381845.340580754\n },\n \"id\": \"velit\",\n \"type\": \"cost_by_org\"\n },\n {\n \"attributes\": {\n \"account_name\": \"sit ut elit quis\",\n \"account_public_id\": \"exercitation minim laboris et\",\n \"charges\": [\n {\n \"charge_type\": \"on_demand\",\n \"cost\": 8235400.667606398,\n \"product_name\": \"infra_host\"\n },\n {\n \"charge_type\": \"on_demand\",\n \"cost\": 23931878.86286345,\n \"product_name\": \"infra_host\"\n }\n ],\n \"date\": \"2009-09-24T19:46:05.610Z\",\n \"org_name\": \"cupidatat\",\n \"public_id\": \"sunt qui anim labore occaecat\",\n \"region\": \"consectetur\",\n \"total_cost\": -47542931.51800091\n },\n \"id\": \"non dolor id\",\n \"type\": \"cost_by_org\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/estimated_cost?view=consectetur consequat dolor&start_month=2009-09-16T14:43:51.288Z&end_month=2009-09-16T14:43:51.288Z&start_date=2009-09-16T14:43:51.288Z&end_date=2009-09-16T14:43:51.288Z&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"estimated_cost"
],
"query": [
{
"key": "view",
"value": "consectetur consequat dolor",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"key": "start_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month. **Either start_month or start_date should be specified, but not both.** (start_month cannot go beyond two months in the past). Provide an `end_month` to view month-over-month cost."
},
{
"key": "end_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
},
{
"key": "start_date",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` for cost beginning this day. **Either start_month or start_date should be specified, but not both.** (start_date cannot go beyond two months in the past). Provide an `end_date` to view day-over-day cumulative cost."
},
{
"key": "end_date",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` for cost ending this day."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden - User is not authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/estimated_cost?view=consectetur consequat dolor&start_month=2009-09-16T14:43:51.288Z&end_month=2009-09-16T14:43:51.288Z&start_date=2009-09-16T14:43:51.288Z&end_date=2009-09-16T14:43:51.288Z&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"estimated_cost"
],
"query": [
{
"key": "view",
"value": "consectetur consequat dolor",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"key": "start_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month. **Either start_month or start_date should be specified, but not both.** (start_month cannot go beyond two months in the past). Provide an `end_month` to view month-over-month cost."
},
{
"key": "end_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
},
{
"key": "start_date",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` for cost beginning this day. **Either start_month or start_date should be specified, but not both.** (start_date cannot go beyond two months in the past). Provide an `end_date` to view day-over-day cumulative cost."
},
{
"key": "end_date",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` for cost ending this day."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/estimated_cost?view=consectetur consequat dolor&start_month=2009-09-16T14:43:51.288Z&end_month=2009-09-16T14:43:51.288Z&start_date=2009-09-16T14:43:51.288Z&end_date=2009-09-16T14:43:51.288Z&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"estimated_cost"
],
"query": [
{
"key": "view",
"value": "consectetur consequat dolor",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"key": "start_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month. **Either start_month or start_date should be specified, but not both.** (start_month cannot go beyond two months in the past). Provide an `end_month` to view month-over-month cost."
},
{
"key": "end_month",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
},
{
"key": "start_date",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` for cost beginning this day. **Either start_month or start_date should be specified, but not both.** (start_date cannot go beyond two months in the past). Provide an `end_date` to view day-over-day cumulative cost."
},
{
"key": "end_date",
"value": "2009-09-16T14:43:51.288Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` for cost ending this day."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get all custom metrics by hourly average",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/top_avg_metrics?month=1993-10-23T16:56:47.315Z&day=1993-10-23T16:56:47.315Z&names=cupidatat sit irure&names=Ut qui Excepteur&limit=500&next_record_id=fugiat id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"top_avg_metrics"
],
"query": [
{
"key": "month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "day",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "names",
"value": "cupidatat sit irure",
"description": "Comma-separated list of metric names."
},
{
"key": "names",
"value": "Ut qui Excepteur",
"description": "Comma-separated list of metric names."
},
{
"key": "limit",
"value": "500",
"description": "Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified."
},
{
"key": "next_record_id",
"value": "fugiat id",
"description": "List following results with a next_record_id provided in the previous query."
}
]
},
"description": "Get all [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/) by hourly average. Use the month parameter to get a month-to-date data resolution or use the day parameter to get a daily resolution. One of the two is required, and only one of the two is allowed."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/top_avg_metrics?month=1993-10-23T16:56:47.315Z&day=1993-10-23T16:56:47.315Z&names=Ut qui Excepteur&limit=500&next_record_id=fugiat id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"top_avg_metrics"
],
"query": [
{
"key": "month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "day",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "names",
"value": "Ut qui Excepteur",
"description": "Comma-separated list of metric names."
},
{
"key": "limit",
"value": "500",
"description": "Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified."
},
{
"key": "next_record_id",
"value": "fugiat id",
"description": "List following results with a next_record_id provided in the previous query."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"metadata\": {\n \"day\": \"2008-06-02T07:33:06.168Z\",\n \"month\": \"1983-04-25T00:28:01.614Z\",\n \"pagination\": {\n \"limit\": -96438034,\n \"next_record_id\": \"do laboris fugiat ad ut\",\n \"total_number_of_records\": -32310868\n }\n },\n \"usage\": [\n {\n \"avg_metric_hour\": 46642136,\n \"max_metric_hour\": 11223608,\n \"metric_category\": \"custom\",\n \"metric_name\": \"nisi Excepteur sed proident\"\n },\n {\n \"avg_metric_hour\": 18695266,\n \"max_metric_hour\": -60473001,\n \"metric_category\": \"custom\",\n \"metric_name\": \"deserunt\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/top_avg_metrics?month=1993-10-23T16:56:47.315Z&day=1993-10-23T16:56:47.315Z&names=Ut qui Excepteur&limit=500&next_record_id=fugiat id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"top_avg_metrics"
],
"query": [
{
"key": "month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "day",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "names",
"value": "Ut qui Excepteur",
"description": "Comma-separated list of metric names."
},
{
"key": "limit",
"value": "500",
"description": "Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified."
},
{
"key": "next_record_id",
"value": "fugiat id",
"description": "List following results with a next_record_id provided in the previous query."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden - User is not authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/top_avg_metrics?month=1993-10-23T16:56:47.315Z&day=1993-10-23T16:56:47.315Z&names=Ut qui Excepteur&limit=500&next_record_id=fugiat id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"top_avg_metrics"
],
"query": [
{
"key": "month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "day",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "names",
"value": "Ut qui Excepteur",
"description": "Comma-separated list of metric names."
},
{
"key": "limit",
"value": "500",
"description": "Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified."
},
{
"key": "next_record_id",
"value": "fugiat id",
"description": "List following results with a next_record_id provided in the previous query."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/top_avg_metrics?month=1993-10-23T16:56:47.315Z&day=1993-10-23T16:56:47.315Z&names=Ut qui Excepteur&limit=500&next_record_id=fugiat id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"top_avg_metrics"
],
"query": [
{
"key": "month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "day",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "names",
"value": "Ut qui Excepteur",
"description": "Comma-separated list of metric names."
},
{
"key": "limit",
"value": "500",
"description": "Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified."
},
{
"key": "next_record_id",
"value": "fugiat id",
"description": "List following results with a next_record_id provided in the previous query."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get projected cost across your account",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/projected_cost?view=consectetur consequat dolor&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"projected_cost"
],
"query": [
{
"key": "view",
"value": "consectetur consequat dolor",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
},
"description": "Get projected cost across multi-org and single root-org accounts.\nProjected cost data is only available for the current month and becomes available around the 12th of the month.\n\nThis endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/projected_cost?view=consectetur consequat dolor&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"projected_cost"
],
"query": [
{
"key": "view",
"value": "consectetur consequat dolor",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"account_name\": \"adipisicing ad exercitation\",\n \"account_public_id\": \"in anim sit\",\n \"charges\": [\n {\n \"charge_type\": \"on_demand\",\n \"cost\": -17171767.080371574,\n \"product_name\": \"infra_host\"\n },\n {\n \"charge_type\": \"on_demand\",\n \"cost\": 96577679.54647368,\n \"product_name\": \"infra_host\"\n }\n ],\n \"date\": \"2003-02-18T19:32:33.936Z\",\n \"org_name\": \"magna ad\",\n \"projected_total_cost\": -95840578.70171605,\n \"public_id\": \"nostrud adipisicing\",\n \"region\": \"laborum ad anim consequat sit\"\n },\n \"id\": \"sunt fugiat qui ea dolor\",\n \"type\": \"projected_cost\"\n },\n {\n \"attributes\": {\n \"account_name\": \"amet exercitation voluptate d\",\n \"account_public_id\": \"tempor\",\n \"charges\": [\n {\n \"charge_type\": \"on_demand\",\n \"cost\": 37280724.694294184,\n \"product_name\": \"infra_host\"\n },\n {\n \"charge_type\": \"on_demand\",\n \"cost\": -35771221.82406074,\n \"product_name\": \"infra_host\"\n }\n ],\n \"date\": \"2024-10-17T13:32:39.258Z\",\n \"org_name\": \"exerci\",\n \"projected_total_cost\": -35348287.16164764,\n \"public_id\": \"ipsum nulla\",\n \"region\": \"et do sunt nostrud Excepteur\"\n },\n \"id\": \"in deserunt\",\n \"type\": \"projected_cost\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/projected_cost?view=consectetur consequat dolor&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"projected_cost"
],
"query": [
{
"key": "view",
"value": "consectetur consequat dolor",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden - User is not authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/projected_cost?view=consectetur consequat dolor&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"projected_cost"
],
"query": [
{
"key": "view",
"value": "consectetur consequat dolor",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/projected_cost?view=consectetur consequat dolor&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"projected_cost"
],
"query": [
{
"key": "view",
"value": "consectetur consequat dolor",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get usage across your account",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/summary?start_month=1993-10-23T16:56:47.315Z&end_month=1993-10-23T16:56:47.315Z&include_org_details=true&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"summary"
],
"query": [
{
"key": "start_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month.\nMaximum of 15 months ago."
},
{
"key": "end_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month."
},
{
"key": "include_org_details",
"value": "true",
"description": "Include usage summaries for each sub-org."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
},
"description": "Get all usage across your account.\n\nThis endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/summary?start_month=1993-10-23T16:56:47.315Z&end_month=1993-10-23T16:56:47.315Z&include_org_details=true&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"summary"
],
"query": [
{
"key": "start_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month.\nMaximum of 15 months ago."
},
{
"key": "end_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month."
},
{
"key": "include_org_details",
"value": "true",
"description": "Include usage summaries for each sub-org."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"agent_host_top99p_sum\": 20587301,\n \"apm_azure_app_service_host_top99p_sum\": 27257698,\n \"apm_devsecops_host_top99p_sum\": -41140009,\n \"apm_fargate_count_avg_sum\": -21311504,\n \"apm_host_top99p_sum\": 70809940,\n \"appsec_fargate_count_avg_sum\": -68943196,\n \"asm_serverless_agg_sum\": 37511412,\n \"audit_trail_enabled_hwm_sum\": -37374875,\n \"avg_profiled_fargate_tasks_sum\": -90489474,\n \"aws_host_top99p_sum\": -56338640,\n \"aws_lambda_func_count\": -17990332,\n \"aws_lambda_invocations_sum\": -4079989,\n \"azure_app_service_top99p_sum\": 81016144,\n \"azure_host_top99p_sum\": -69342970,\n \"billable_ingested_bytes_agg_sum\": 43608703,\n \"browser_rum_replay_session_count_agg_sum\": -50409633,\n \"ci_pipeline_indexed_spans_agg_sum\": 98809696,\n \"ci_test_indexed_spans_agg_sum\": 17308238,\n \"ci_visibility_itr_committers_hwm_sum\": -7683386,\n \"ci_visibility_pipeline_committers_hwm_sum\": 1340527,\n \"ci_visibility_test_committers_hwm_sum\": 22390881,\n \"cloud_cost_management_aws_host_count_avg_sum\": -1288432,\n \"cloud_cost_management_azure_host_count_avg_sum\": -3168015,\n \"cloud_cost_management_gcp_host_count_avg_sum\": 12726084,\n \"cloud_cost_management_host_count_avg_sum\": -9286719,\n \"cloud_siem_events_agg_sum\": -25133827,\n \"code_analysis_sa_committers_hwm_sum\": 57650263,\n \"code_analysis_sca_committers_hwm_sum\": -77517453,\n \"code_security_host_top99p_sum\": 9350421,\n \"container_avg_sum\": -1350903,\n \"container_excl_agent_avg_sum\": -42745037,\n \"container_hwm_sum\": -61935237,\n \"csm_container_enterprise_compliance_count_agg_sum\": -92216796,\n \"csm_container_enterprise_cws_count_agg_sum\": 28493227,\n \"csm_container_enterprise_total_count_agg_sum\": -65700077,\n \"csm_host_enterprise_aas_host_count_top99p_sum\": 37624952,\n \"csm_host_enterprise_aws_host_count_top99p_sum\": 51237283,\n \"csm_host_enterprise_azure_host_count_top99p_sum\": 57837104,\n \"csm_host_enterprise_compliance_host_count_top99p_sum\": 26146661,\n \"csm_host_enterprise_cws_host_count_top99p_sum\": 39129990,\n \"csm_host_enterprise_gcp_host_count_top99p_sum\": -64538125,\n \"csm_host_enterprise_total_host_count_top99p_sum\": -72357911,\n \"cspm_aas_host_top99p_sum\": 5056440,\n \"cspm_aws_host_top99p_sum\": -26620698,\n \"cspm_azure_host_top99p_sum\": -13414585,\n \"cspm_container_avg_sum\": -26765894,\n \"cspm_container_hwm_sum\": 53497564,\n \"cspm_gcp_host_top99p_sum\": 88244864,\n \"cspm_host_top99p_sum\": 72598364,\n \"custom_historical_ts_sum\": -67329053,\n \"custom_live_ts_sum\": 33101681,\n \"custom_ts_sum\": 20553677,\n \"cws_container_avg_sum\": -78348134,\n \"cws_fargate_task_avg_sum\": -94074008,\n \"cws_host_top99p_sum\": 61779651,\n \"data_jobs_monitoring_host_hr_agg_sum\": 32486850,\n \"dbm_host_top99p_sum\": 62664801,\n \"dbm_queries_avg_sum\": -27499963,\n \"end_date\": \"1948-05-20T04:52:38.891Z\",\n \"eph_infra_host_agent_agg_sum\": -6166635,\n \"eph_infra_host_alibaba_agg_sum\": -55290561,\n \"eph_infra_host_aws_agg_sum\": -10460919,\n \"eph_infra_host_azure_agg_sum\": 43046381,\n \"eph_infra_host_ent_agg_sum\": 63863522,\n \"eph_infra_host_gcp_agg_sum\": 25141984,\n \"eph_infra_host_heroku_agg_sum\": -98890573,\n \"eph_infra_host_only_aas_agg_sum\": 96210626,\n \"eph_infra_host_only_vsphere_agg_sum\": 68708748,\n \"eph_infra_host_opentelemetry_agg_sum\": 34779929,\n \"eph_infra_host_opentelemetry_apm_agg_sum\": -51275378,\n \"eph_infra_host_pro_agg_sum\": -94137250,\n \"eph_infra_host_proplus_agg_sum\": 72847108,\n \"error_tracking_apm_error_events_agg_sum\": 15941901,\n \"error_tracking_error_events_agg_sum\": -72313659,\n \"error_tracking_events_agg_sum\": -49182547,\n \"error_tracking_rum_error_events_agg_sum\": 25632879,\n \"event_management_correlation_agg_sum\": 3347276,\n \"event_management_correlation_correlated_events_agg_sum\": 4710351,\n \"event_management_correlation_correlated_related_events_agg_sum\": -59660294,\n \"fargate_container_profiler_profiling_fargate_avg_sum\": -2919801,\n \"fargate_container_profiler_profiling_fargate_eks_avg_sum\": -4096991,\n \"fargate_tasks_count_avg_sum\": 12802965,\n \"fargate_tasks_count_hwm_sum\": -70217962,\n \"flex_logs_compute_large_avg_sum\": -78706675,\n \"flex_logs_compute_medium_avg_sum\": 53016833,\n \"flex_logs_compute_small_avg_sum\": -81844501,\n \"flex_logs_compute_xlarge_avg_sum\": 41927007,\n \"flex_logs_compute_xsmall_avg_sum\": 21926262,\n \"flex_logs_starter_avg_sum\": 68035735,\n \"flex_logs_starter_storage_index_avg_sum\": 79604601,\n \"flex_logs_starter_storage_retention_adjustment_avg_sum\": -63334039,\n \"flex_stored_logs_avg_sum\": -1408101,\n \"forwarding_events_bytes_agg_sum\": -1796930,\n \"gcp_host_top99p_sum\": -55908391,\n \"heroku_host_top99p_sum\": 92702089,\n \"incident_management_monthly_active_users_hwm_sum\": -39472938,\n \"infra_host_top99p_sum\": -62964493,\n \"ingested_events_bytes_agg_sum\": -79385744,\n \"iot_device_agg_sum\": 32301484,\n \"iot_device_top99p_sum\": 71284507,\n \"last_updated\": \"1966-08-01T13:47:24.537Z\",\n \"live_ingested_bytes_agg_sum\": -2716654,\n \"llm_observability_agg_sum\": -42279114,\n \"llm_observability_min_spend_agg_sum\": 79460423,\n \"logs_by_retention\": {\n \"orgs\": {\n \"usage\": [\n {\n \"usage\": [\n {\n \"logs_indexed_logs_usage_sum\": 72283179,\n \"logs_live_indexed_logs_usage_sum\": -42674507,\n \"logs_rehydrated_indexed_logs_usage_sum\": 57850659,\n \"retention\": \"in reprehenderit laboris Duis sed\"\n },\n {\n \"logs_indexed_logs_usage_sum\": 899010,\n \"logs_live_indexed_logs_usage_sum\": 28163686,\n \"logs_rehydrated_indexed_logs_usage_sum\": -92086398,\n \"retention\": \"pariatur com\"\n }\n ]\n },\n {\n \"usage\": [\n {\n \"logs_indexed_logs_usage_sum\": -34226190,\n \"logs_live_indexed_logs_usage_sum\": -10285445,\n \"logs_rehydrated_indexed_logs_usage_sum\": -49538853,\n \"retention\": \"exercitation sint et\"\n },\n {\n \"logs_indexed_logs_usage_sum\": -11590049,\n \"logs_live_indexed_logs_usage_sum\": -13284678,\n \"logs_rehydrated_indexed_logs_usage_sum\": 93683004,\n \"retention\": \"quis dolor sit culpa ea\"\n }\n ]\n }\n ]\n },\n \"usage\": [\n {\n \"logs_indexed_logs_usage_agg_sum\": 14426627,\n \"logs_live_indexed_logs_usage_agg_sum\": -74926260,\n \"logs_rehydrated_indexed_logs_usage_agg_sum\": 76603215,\n \"retention\": \"nostrud \"\n },\n {\n \"logs_indexed_logs_usage_agg_sum\": 88960911,\n \"logs_live_indexed_logs_usage_agg_sum\": 31587240,\n \"logs_rehydrated_indexed_logs_usage_agg_sum\": 68550693,\n \"retention\": \"eu Lorem magna sunt\"\n }\n ],\n \"usage_by_month\": {\n \"date\": \"2014-04-02T08:35:08.341Z\",\n \"usage\": [\n {\n \"logs_indexed_logs_usage_sum\": -50965134,\n \"logs_live_indexed_logs_usage_sum\": 44332159,\n \"logs_rehydrated_indexed_logs_usage_sum\": 99706452,\n \"retention\": \"dolor ex ut\"\n },\n {\n \"logs_indexed_logs_usage_sum\": -84017628,\n \"logs_live_indexed_logs_usage_sum\": -95246524,\n \"logs_rehydrated_indexed_logs_usage_sum\": -36712458,\n \"retention\": \"laborum est ad\"\n }\n ]\n }\n },\n \"ndm_netflow_events_agg_sum\": 21256029,\n \"network_device_wireless_top99p_sum\": 51483881,\n \"npm_host_top99p_sum\": 64732102,\n \"observability_pipelines_bytes_processed_agg_sum\": 96599301,\n \"oci_host_agg_sum\": 36853251,\n \"oci_host_top99p_sum\": -12219588,\n \"online_archive_events_count_agg_sum\": -32728265,\n \"opentelemetry_apm_host_top99p_sum\": 74709935,\n \"opentelemetry_host_top99p_sum\": -46602006,\n \"product_analytics_agg_sum\": -45575549,\n \"profiling_aas_count_top99p_sum\": -73563496,\n \"profiling_container_agent_count_avg\": -38563643,\n \"profiling_host_count_top99p_sum\": -60357608,\n \"published_app_hwm_sum\": -44064591,\n \"rehydrated_ingested_bytes_agg_sum\": -68416569,\n \"rum_browser_and_mobile_session_count\": -68854384,\n \"rum_browser_legacy_session_count_agg_sum\": 46889426,\n \"rum_browser_lite_session_count_agg_sum\": -82448586,\n \"rum_browser_replay_session_count_agg_sum\": -18300542,\n \"rum_indexed_sessions_agg_sum\": 32802520,\n \"rum_ingested_sessions_agg_sum\": 49460170,\n \"rum_lite_session_count_agg_sum\": 9078368,\n \"rum_mobile_legacy_session_count_android_agg_sum\": 46389420,\n \"rum_mobile_legacy_session_count_flutter_agg_sum\": 65357633,\n \"rum_mobile_legacy_session_count_ios_agg_sum\": 11502741,\n \"rum_mobile_legacy_session_count_reactnative_agg_sum\": -99356198,\n \"rum_mobile_legacy_session_count_roku_agg_sum\": -6048306,\n \"rum_mobile_lite_session_count_android_agg_sum\": -76652135,\n \"rum_mobile_lite_session_count_flutter_agg_sum\": -70539183,\n \"rum_mobile_lite_session_count_ios_agg_sum\": 34246645,\n \"rum_mobile_lite_session_count_kotlinmultiplatform_agg_sum\": -74910045,\n \"rum_mobile_lite_session_count_reactnative_agg_sum\": -96316635,\n \"rum_mobile_lite_session_count_roku_agg_sum\": -6749790,\n \"rum_mobile_lite_session_count_unity_agg_sum\": -17782358,\n \"rum_mobile_replay_session_count_android_agg_sum\": 60203323,\n \"rum_mobile_replay_session_count_ios_agg_sum\": 13045922,\n \"rum_mobile_replay_session_count_kotlinmultiplatform_agg_sum\": -4988652,\n \"rum_mobile_replay_session_count_reactnative_agg_sum\": 15064801,\n \"rum_replay_session_count_agg_sum\": 25961482,\n \"rum_session_replay_add_on_agg_sum\": -81053901,\n \"rum_total_session_count_agg_sum\": -94943100,\n \"sca_fargate_count_avg_sum\": 53191143,\n \"sca_fargate_count_hwm_sum\": -38430742,\n \"sds_apm_scanned_bytes_sum\": -679632,\n \"sds_events_scanned_bytes_sum\": -61392960,\n \"sds_logs_scanned_bytes_sum\": 69944866,\n \"sds_rum_scanned_bytes_sum\": 93911358,\n \"sds_total_scanned_bytes_sum\": -87728094,\n \"serverless_apps_azure_count_avg_sum\": 44351025,\n \"serverless_apps_google_count_avg_sum\": 57925117,\n \"serverless_apps_total_count_avg_sum\": 64517042,\n \"siem_analyzed_logs_add_on_count_agg_sum\": -99028529,\n \"start_date\": \"2006-08-15T02:48:28.856Z\",\n \"synthetics_browser_check_calls_count_agg_sum\": 79508421,\n \"synthetics_check_calls_count_agg_sum\": -12572297,\n \"synthetics_mobile_test_runs_agg_sum\": -97829166,\n \"synthetics_parallel_testing_max_slots_hwm_sum\": -63722024,\n \"trace_search_indexed_events_count_agg_sum\": 14673826,\n \"twol_ingested_events_bytes_agg_sum\": 32955886,\n \"universal_service_monitoring_host_top99p_sum\": 93052472,\n \"usage\": [\n {\n \"agent_host_top99p\": -35763679,\n \"apm_azure_app_service_host_top99p\": 84229898,\n \"apm_devsecops_host_top99p\": -46112590,\n \"apm_fargate_count_avg\": -87623939,\n \"apm_host_top99p\": -3712515,\n \"appsec_fargate_count_avg\": -65861070,\n \"asm_serverless_sum\": 58809647,\n \"audit_trail_enabled_hwm\": -69996214,\n \"avg_profiled_fargate_tasks\": -38607370,\n \"aws_host_top99p\": -41199376,\n \"aws_lambda_func_count\": -86263143,\n \"aws_lambda_invocations_sum\": -48826438,\n \"azure_app_service_top99p\": 79315595,\n \"billable_ingested_bytes_sum\": 40208622,\n \"browser_rum_replay_session_count_sum\": 28337694,\n \"ci_pipeline_indexed_spans_sum\": 36559557,\n \"ci_test_indexed_spans_sum\": 62802543,\n \"ci_visibility_itr_committers_hwm\": 8137868,\n \"ci_visibility_pipeline_committers_hwm\": 14024117,\n \"ci_visibility_test_committers_hwm\": 84006467,\n \"cloud_cost_management_aws_host_count_avg\": 4897286,\n \"cloud_cost_management_azure_host_count_avg\": 29008646,\n \"cloud_cost_management_gcp_host_count_avg\": 29538317,\n \"cloud_cost_management_host_count_avg\": 23688285,\n \"cloud_siem_events_sum\": 63533345,\n \"code_analysis_sa_committers_hwm\": 95556134,\n \"code_analysis_sca_committers_hwm\": 25169872,\n \"code_security_host_top99p\": -64665469,\n \"container_avg\": 10336958,\n \"container_excl_agent_avg\": -13777591,\n \"container_hwm\": -9714240,\n \"csm_container_enterprise_compliance_count_sum\": 63332230,\n \"csm_container_enterprise_cws_count_sum\": 31861771,\n \"csm_container_enterprise_total_count_sum\": -89875893,\n \"csm_host_enterprise_aas_host_count_top99p\": -62235603,\n \"csm_host_enterprise_aws_host_count_top99p\": 29609300,\n \"csm_host_enterprise_azure_host_count_top99p\": -92266700,\n \"csm_host_enterprise_compliance_host_count_top99p\": 92472294,\n \"csm_host_enterprise_cws_host_count_top99p\": -4962396,\n \"csm_host_enterprise_gcp_host_count_top99p\": 51841324,\n \"csm_host_enterprise_total_host_count_top99p\": -33190794,\n \"cspm_aas_host_top99p\": -25759375,\n \"cspm_aws_host_top99p\": 45078983,\n \"cspm_azure_host_top99p\": -77876575,\n \"cspm_container_avg\": 79734778,\n \"cspm_container_hwm\": -3347220,\n \"cspm_gcp_host_top99p\": 10501462,\n \"cspm_host_top99p\": -3174041,\n \"custom_ts_avg\": -92762929,\n \"cws_container_count_avg\": 16929648,\n \"cws_fargate_task_avg\": 84885511,\n \"cws_host_top99p\": -95569423,\n \"data_jobs_monitoring_host_hr_sum\": 79462717,\n \"date\": \"1945-12-24T18:56:59.030Z\",\n \"dbm_host_top99p\": 55718894,\n \"dbm_queries_count_avg\": 81482536,\n \"eph_infra_host_agent_sum\": 65982078,\n \"eph_infra_host_alibaba_sum\": 42976657,\n \"eph_infra_host_aws_sum\": -89634581,\n \"eph_infra_host_azure_sum\": 29650069,\n \"eph_infra_host_ent_sum\": 37816369,\n \"eph_infra_host_gcp_sum\": -90344475,\n \"eph_infra_host_heroku_sum\": 9219381,\n \"eph_infra_host_only_aas_sum\": -94123160,\n \"eph_infra_host_only_vsphere_sum\": -3165764,\n \"eph_infra_host_opentelemetry_apm_sum\": -81641935,\n \"eph_infra_host_opentelemetry_sum\": 47234525,\n \"eph_infra_host_pro_sum\": 30768455,\n \"eph_infra_host_proplus_sum\": 56821223,\n \"error_tracking_apm_error_events_sum\": 51448612,\n \"error_tracking_error_events_sum\": -20138898,\n \"error_tracking_events_sum\": 78555572,\n \"error_tracking_rum_error_events_sum\": 85240637,\n \"event_management_correlation_correlated_events_sum\": 76498405,\n \"event_management_correlation_correlated_related_events_sum\": 31585644,\n \"event_management_correlation_sum\": 22452588,\n \"fargate_container_profiler_profiling_fargate_avg\": -4494440,\n \"fargate_container_profiler_profiling_fargate_eks_avg\": -73804007,\n \"fargate_tasks_count_avg\": -37234272,\n \"fargate_tasks_count_hwm\": -25991617,\n \"flex_logs_compute_large_avg\": 86230822,\n \"flex_logs_compute_medium_avg\": -53387699,\n \"flex_logs_compute_small_avg\": -94778057,\n \"flex_logs_compute_xlarge_avg\": 76177047,\n \"flex_logs_compute_xsmall_avg\": -63150419,\n \"flex_logs_starter_avg\": -87550589,\n \"flex_logs_starter_storage_index_avg\": -6582939,\n \"flex_logs_starter_storage_retention_adjustment_avg\": -76748075,\n \"flex_stored_logs_avg\": 75758919,\n \"forwarding_events_bytes_sum\": -50893025,\n \"gcp_host_top99p\": 7879629,\n \"heroku_host_top99p\": 70139841,\n \"incident_management_monthly_active_users_hwm\": -53776589,\n \"indexed_events_count_sum\": 89642068,\n \"infra_host_top99p\": 58016977,\n \"ingested_events_bytes_sum\": -52495105,\n \"iot_device_sum\": -27348221,\n \"iot_device_top99p\": 93129688,\n \"llm_observability_min_spend_sum\": 89619443,\n \"llm_observability_sum\": 960451,\n \"ndm_netflow_events_sum\": 88764714,\n \"network_device_wireless_top99p\": 78635642,\n \"npm_host_top99p\": 85544293,\n \"observability_pipelines_bytes_processed_sum\": 10514445,\n \"oci_host_sum\": -10953020,\n \"oci_host_top99p\": -39647170,\n \"online_archive_events_count_sum\": -63745935,\n \"opentelemetry_apm_host_top99p\": -58805041,\n \"opentelemetry_host_top99p\": -20090407,\n \"orgs\": [\n {\n \"account_name\": \"enim amet\",\n \"account_public_id\": \"anim id in\",\n \"agent_host_top99p\": -9656862,\n \"apm_azure_app_service_host_top99p\": -44704634,\n \"apm_devsecops_host_top99p\": 79516274,\n \"apm_fargate_count_avg\": 72712017,\n \"apm_host_top99p\": -77084261,\n \"appsec_fargate_count_avg\": 33414308,\n \"asm_serverless_sum\": -51360449,\n \"audit_trail_enabled_hwm\": -48721212,\n \"avg_profiled_fargate_tasks\": 79374404,\n \"aws_host_top99p\": 76976397,\n \"aws_lambda_func_count\": 88981536,\n \"aws_lambda_invocations_sum\": 51972556,\n \"azure_app_service_top99p\": -6361153,\n \"billable_ingested_bytes_sum\": 51485711,\n \"browser_rum_replay_session_count_sum\": 55937788,\n \"ci_pipeline_indexed_spans_sum\": 21081618,\n \"ci_test_indexed_spans_sum\": -79520699,\n \"ci_visibility_itr_committers_hwm\": 62995645,\n \"ci_visibility_pipeline_committers_hwm\": -83579341,\n \"ci_visibility_test_committers_hwm\": -51717023,\n \"cloud_cost_management_aws_host_count_avg\": 93522015,\n \"cloud_cost_management_azure_host_count_avg\": 87068822,\n \"cloud_cost_management_gcp_host_count_avg\": 26181949,\n \"cloud_cost_management_host_count_avg\": 26314617,\n \"cloud_siem_events_sum\": -69766875,\n \"code_analysis_sa_committers_hwm\": 36908511,\n \"code_analysis_sca_committers_hwm\": 31652812,\n \"code_security_host_top99p\": 14383079,\n \"container_avg\": 47149380,\n \"container_excl_agent_avg\": 50619148,\n \"container_hwm\": -17217605,\n \"csm_container_enterprise_compliance_count_sum\": -78130700,\n \"csm_container_enterprise_cws_count_sum\": -9075028,\n \"csm_container_enterprise_total_count_sum\": 94879726,\n \"csm_host_enterprise_aas_host_count_top99p\": 28140449,\n \"csm_host_enterprise_aws_host_count_top99p\": -35537438,\n \"csm_host_enterprise_azure_host_count_top99p\": -75517219,\n \"csm_host_enterprise_compliance_host_count_top99p\": 66011351,\n \"csm_host_enterprise_cws_host_count_top99p\": 29855432,\n \"csm_host_enterprise_gcp_host_count_top99p\": -56845759,\n \"csm_host_enterprise_total_host_count_top99p\": 26591422,\n \"cspm_aas_host_top99p\": -70320405,\n \"cspm_aws_host_top99p\": -59957848,\n \"cspm_azure_host_top99p\": 96506320,\n \"cspm_container_avg\": 9195973,\n \"cspm_container_hwm\": 42585148,\n \"cspm_gcp_host_top99p\": 78576634,\n \"cspm_host_top99p\": -57911994,\n \"custom_historical_ts_avg\": 15507689,\n \"custom_live_ts_avg\": 78202047,\n \"custom_ts_avg\": -38636871,\n \"cws_container_count_avg\": 30623471,\n \"cws_fargate_task_avg\": 44668090,\n \"cws_host_top99p\": 64531820,\n \"data_jobs_monitoring_host_hr_sum\": 18693664,\n \"dbm_host_top99p_sum\": -31320577,\n \"dbm_queries_avg_sum\": 44058902,\n \"eph_infra_host_agent_sum\": -51063264,\n \"eph_infra_host_alibaba_sum\": -10349355,\n \"eph_infra_host_aws_sum\": 79490858,\n \"eph_infra_host_azure_sum\": -95720039,\n \"eph_infra_host_ent_sum\": 14652913,\n \"eph_infra_host_gcp_sum\": 71158906,\n \"eph_infra_host_heroku_sum\": 58238117,\n \"eph_infra_host_only_aas_sum\": -68799534,\n \"eph_infra_host_only_vsphere_sum\": -8389946,\n \"eph_infra_host_opentelemetry_apm_sum\": 3493056,\n \"eph_infra_host_opentelemetry_sum\": 41868241,\n \"eph_infra_host_pro_sum\": 87374297,\n \"eph_infra_host_proplus_sum\": 59068810,\n \"error_tracking_apm_error_events_sum\": 35362541,\n \"error_tracking_error_events_sum\": 69018925,\n \"error_tracking_events_sum\": 52888985,\n \"error_tracking_rum_error_events_sum\": 28784742,\n \"event_management_correlation_correlated_events_sum\": -64768649,\n \"event_management_correlation_correlated_related_events_sum\": 88518829,\n \"event_management_correlation_sum\": -75454802,\n \"fargate_container_profiler_profiling_fargate_avg\": 15356051,\n \"fargate_container_profiler_profiling_fargate_eks_avg\": -6278019,\n \"fargate_tasks_count_avg\": -82218444,\n \"fargate_tasks_count_hwm\": -28949198,\n \"flex_logs_compute_large_avg\": 50191672,\n \"flex_logs_compute_medium_avg\": 87347855,\n \"flex_logs_compute_small_avg\": -38057571,\n \"flex_logs_compute_xlarge_avg\": -79149607,\n \"flex_logs_compute_xsmall_avg\": -92001088,\n \"flex_logs_starter_avg\": -25859182,\n \"flex_logs_starter_storage_index_avg\": 86467249,\n \"flex_logs_starter_storage_retention_adjustment_avg\": -75100620,\n \"flex_stored_logs_avg\": 34911798,\n \"forwarding_events_bytes_sum\": -9121296,\n \"gcp_host_top99p\": -67176990,\n \"heroku_host_top99p\": 87745206,\n \"id\": \"enim\",\n \"incident_management_monthly_active_users_hwm\": 43054336,\n \"infra_host_top99p\": 62340971,\n \"ingested_events_bytes_sum\": -84033130,\n \"iot_device_agg_sum\": 83785161,\n \"iot_device_top99p_sum\": 89274954,\n \"llm_observability_min_spend_sum\": 95776017,\n \"llm_observability_sum\": -66643029,\n \"name\": \"aliqua proident nisi\",\n \"ndm_netflow_events_sum\": -20644731,\n \"network_device_wireless_top99p\": -38919989,\n \"npm_host_top99p\": -14534952,\n \"observability_pipelines_bytes_processed_sum\": -27830895,\n \"oci_host_sum\": -21650231,\n \"oci_host_top99p\": -66727858,\n \"online_archive_events_count_sum\": 84884833,\n \"opentelemetry_apm_host_top99p\": 12304325,\n \"opentelemetry_host_top99p\": -80624365,\n \"product_analytics_sum\": 70362784,\n \"profiling_aas_count_top99p\": 8930957,\n \"profiling_host_top99p\": -44498034,\n \"public_id\": \"sit nulla eiusmod in est\",\n \"published_app_hwm\": -55047808,\n \"region\": \"veniam est Duis\",\n \"rum_browser_and_mobile_session_count\": 75762970,\n \"rum_browser_legacy_session_count_sum\": -74201199,\n \"rum_browser_lite_session_count_sum\": 26383474,\n \"rum_browser_replay_session_count_sum\": 99764921,\n \"rum_indexed_sessions_sum\": -77557556,\n \"rum_ingested_sessions_sum\": -78281367,\n \"rum_lite_session_count_sum\": 72829311,\n \"rum_mobile_legacy_session_count_android_sum\": 1093260,\n \"rum_mobile_legacy_session_count_flutter_sum\": -44917145,\n \"rum_mobile_legacy_session_count_ios_sum\": -65056699,\n \"rum_mobile_legacy_session_count_reactnative_sum\": 97684519,\n \"rum_mobile_legacy_session_count_roku_sum\": 53059303,\n \"rum_mobile_lite_session_count_android_sum\": 81769494,\n \"rum_mobile_lite_session_count_flutter_sum\": -78622461,\n \"rum_mobile_lite_session_count_ios_sum\": 87984060,\n \"rum_mobile_lite_session_count_kotlinmultiplatform_sum\": 91808788,\n \"rum_mobile_lite_session_count_reactnative_sum\": 51323321,\n \"rum_mobile_lite_session_count_roku_sum\": -22039003,\n \"rum_mobile_lite_session_count_unity_sum\": 692463,\n \"rum_mobile_replay_session_count_android_sum\": -91145762,\n \"rum_mobile_replay_session_count_ios_sum\": 73098597,\n \"rum_mobile_replay_session_count_kotlinmultiplatform_sum\": -95644742,\n \"rum_mobile_replay_session_count_reactnative_sum\": 91285670,\n \"rum_replay_session_count_sum\": 31810880,\n \"rum_session_replay_add_on_sum\": -97474740,\n \"rum_total_session_count_sum\": 95332587,\n \"sca_fargate_count_avg\": 78965829,\n \"sca_fargate_count_hwm\": 10202379,\n \"sds_apm_scanned_bytes_sum\": 68099210,\n \"sds_events_scanned_bytes_sum\": 43244912,\n \"sds_logs_scanned_bytes_sum\": 97872838,\n \"sds_rum_scanned_bytes_sum\": -58783220,\n \"sds_total_scanned_bytes_sum\": 98112565,\n \"serverless_apps_azure_count_avg\": 32323662,\n \"serverless_apps_google_count_avg\": 58601220,\n \"serverless_apps_total_count_avg\": 51181153,\n \"siem_analyzed_logs_add_on_count_sum\": 35485066,\n \"synthetics_browser_check_calls_count_sum\": 54185048,\n \"synthetics_check_calls_count_sum\": -31685077,\n \"synthetics_mobile_test_runs_sum\": -6718212,\n \"synthetics_parallel_testing_max_slots_hwm\": -12577435,\n \"trace_search_indexed_events_count_sum\": 18602695,\n \"twol_ingested_events_bytes_sum\": 68683028,\n \"universal_service_monitoring_host_top99p\": 33821755,\n \"vsphere_host_top99p\": -80388368,\n \"vuln_management_host_count_top99p\": 93350340,\n \"workflow_executions_usage_sum\": 48300410\n },\n {\n \"account_name\": \"anim ullamco sunt mollit\",\n \"account_public_id\": \"id\",\n \"agent_host_top99p\": -89080354,\n \"apm_azure_app_service_host_top99p\": 78452249,\n \"apm_devsecops_host_top99p\": -3198865,\n \"apm_fargate_count_avg\": 83856414,\n \"apm_host_top99p\": -5406576,\n \"appsec_fargate_count_avg\": -44818284,\n \"asm_serverless_sum\": -94761940,\n \"audit_trail_enabled_hwm\": 69923271,\n \"avg_profiled_fargate_tasks\": -42652929,\n \"aws_host_top99p\": 24694967,\n \"aws_lambda_func_count\": -89136305,\n \"aws_lambda_invocations_sum\": -20350253,\n \"azure_app_service_top99p\": 30937883,\n \"billable_ingested_bytes_sum\": 82839778,\n \"browser_rum_replay_session_count_sum\": -30977151,\n \"ci_pipeline_indexed_spans_sum\": 9060699,\n \"ci_test_indexed_spans_sum\": -93308830,\n \"ci_visibility_itr_committers_hwm\": 87263303,\n \"ci_visibility_pipeline_committers_hwm\": -3327543,\n \"ci_visibility_test_committers_hwm\": 71060066,\n \"cloud_cost_management_aws_host_count_avg\": 21232274,\n \"cloud_cost_management_azure_host_count_avg\": 95283800,\n \"cloud_cost_management_gcp_host_count_avg\": -29800421,\n \"cloud_cost_management_host_count_avg\": -86504229,\n \"cloud_siem_events_sum\": 35590398,\n \"code_analysis_sa_committers_hwm\": 53452126,\n \"code_analysis_sca_committers_hwm\": 81262763,\n \"code_security_host_top99p\": 88821694,\n \"container_avg\": 25415328,\n \"container_excl_agent_avg\": 51009913,\n \"container_hwm\": 611694,\n \"csm_container_enterprise_compliance_count_sum\": -94806628,\n \"csm_container_enterprise_cws_count_sum\": 93495334,\n \"csm_container_enterprise_total_count_sum\": -39126936,\n \"csm_host_enterprise_aas_host_count_top99p\": -86734826,\n \"csm_host_enterprise_aws_host_count_top99p\": 20146423,\n \"csm_host_enterprise_azure_host_count_top99p\": 74354874,\n \"csm_host_enterprise_compliance_host_count_top99p\": -45331955,\n \"csm_host_enterprise_cws_host_count_top99p\": 3642978,\n \"csm_host_enterprise_gcp_host_count_top99p\": -26917199,\n \"csm_host_enterprise_total_host_count_top99p\": 16205712,\n \"cspm_aas_host_top99p\": 39513544,\n \"cspm_aws_host_top99p\": 66521940,\n \"cspm_azure_host_top99p\": -3154684,\n \"cspm_container_avg\": -83455884,\n \"cspm_container_hwm\": -62588754,\n \"cspm_gcp_host_top99p\": -21856511,\n \"cspm_host_top99p\": -74628885,\n \"custom_historical_ts_avg\": 58825677,\n \"custom_live_ts_avg\": 16416470,\n \"custom_ts_avg\": -57587407,\n \"cws_container_count_avg\": -14178220,\n \"cws_fargate_task_avg\": 94325546,\n \"cws_host_top99p\": 4960698,\n \"data_jobs_monitoring_host_hr_sum\": -52678193,\n \"dbm_host_top99p_sum\": -82073923,\n \"dbm_queries_avg_sum\": 47374936,\n \"eph_infra_host_agent_sum\": -3781694,\n \"eph_infra_host_alibaba_sum\": -97833855,\n \"eph_infra_host_aws_sum\": 81488091,\n \"eph_infra_host_azure_sum\": 67388612,\n \"eph_infra_host_ent_sum\": 50072642,\n \"eph_infra_host_gcp_sum\": -76304323,\n \"eph_infra_host_heroku_sum\": 78602410,\n \"eph_infra_host_only_aas_sum\": 24627174,\n \"eph_infra_host_only_vsphere_sum\": 44478155,\n \"eph_infra_host_opentelemetry_apm_sum\": 18726128,\n \"eph_infra_host_opentelemetry_sum\": 78500153,\n \"eph_infra_host_pro_sum\": -58754016,\n \"eph_infra_host_proplus_sum\": 42146750,\n \"error_tracking_apm_error_events_sum\": -25159585,\n \"error_tracking_error_events_sum\": -37553186,\n \"error_tracking_events_sum\": -82668421,\n \"error_tracking_rum_error_events_sum\": 8627087,\n \"event_management_correlation_correlated_events_sum\": -13043480,\n \"event_management_correlation_correlated_related_events_sum\": -70147905,\n \"event_management_correlation_sum\": -46705852,\n \"fargate_container_profiler_profiling_fargate_avg\": -67940733,\n \"fargate_container_profiler_profiling_fargate_eks_avg\": 79154276,\n \"fargate_tasks_count_avg\": 55581496,\n \"fargate_tasks_count_hwm\": -73896780,\n \"flex_logs_compute_large_avg\": -31818650,\n \"flex_logs_compute_medium_avg\": -75445728,\n \"flex_logs_compute_small_avg\": -12126115,\n \"flex_logs_compute_xlarge_avg\": -8267729,\n \"flex_logs_compute_xsmall_avg\": -84339703,\n \"flex_logs_starter_avg\": -60958644,\n \"flex_logs_starter_storage_index_avg\": -60149552,\n \"flex_logs_starter_storage_retention_adjustment_avg\": -23828565,\n \"flex_stored_logs_avg\": 46898292,\n \"forwarding_events_bytes_sum\": 48035421,\n \"gcp_host_top99p\": -69449383,\n \"heroku_host_top99p\": 24686197,\n \"id\": \"nisi non labore ipsum in\",\n \"incident_management_monthly_active_users_hwm\": -43913143,\n \"infra_host_top99p\": -81491674,\n \"ingested_events_bytes_sum\": 47327840,\n \"iot_device_agg_sum\": 43382360,\n \"iot_device_top99p_sum\": 28767381,\n \"llm_observability_min_spend_sum\": 87772404,\n \"llm_observability_sum\": -37659882,\n \"name\": \"in anim fugiat amet\",\n \"ndm_netflow_events_sum\": 41499870,\n \"network_device_wireless_top99p\": -5809374,\n \"npm_host_top99p\": -4607462,\n \"observability_pipelines_bytes_processed_sum\": 58478554,\n \"oci_host_sum\": -89265392,\n \"oci_host_top99p\": 92680001,\n \"online_archive_events_count_sum\": -59731135,\n \"opentelemetry_apm_host_top99p\": 7025305,\n \"opentelemetry_host_top99p\": -65378695,\n \"product_analytics_sum\": -3716511,\n \"profiling_aas_count_top99p\": -70772113,\n \"profiling_host_top99p\": 81423781,\n \"public_id\": \"labore Duis et l\",\n \"published_app_hwm\": 29039131,\n \"region\": \"enim e\",\n \"rum_browser_and_mobile_session_count\": -58842723,\n \"rum_browser_legacy_session_count_sum\": 16911281,\n \"rum_browser_lite_session_count_sum\": -84396351,\n \"rum_browser_replay_session_count_sum\": -95943787,\n \"rum_indexed_sessions_sum\": -27770930,\n \"rum_ingested_sessions_sum\": -98867539,\n \"rum_lite_session_count_sum\": 43679026,\n \"rum_mobile_legacy_session_count_android_sum\": -7810161,\n \"rum_mobile_legacy_session_count_flutter_sum\": -83516025,\n \"rum_mobile_legacy_session_count_ios_sum\": 22754276,\n \"rum_mobile_legacy_session_count_reactnative_sum\": 72441136,\n \"rum_mobile_legacy_session_count_roku_sum\": 63781294,\n \"rum_mobile_lite_session_count_android_sum\": 13898423,\n \"rum_mobile_lite_session_count_flutter_sum\": -10969575,\n \"rum_mobile_lite_session_count_ios_sum\": -98367375,\n \"rum_mobile_lite_session_count_kotlinmultiplatform_sum\": -43806870,\n \"rum_mobile_lite_session_count_reactnative_sum\": -36289924,\n \"rum_mobile_lite_session_count_roku_sum\": 77949941,\n \"rum_mobile_lite_session_count_unity_sum\": 8252453,\n \"rum_mobile_replay_session_count_android_sum\": 72066155,\n \"rum_mobile_replay_session_count_ios_sum\": -91905837,\n \"rum_mobile_replay_session_count_kotlinmultiplatform_sum\": -63382689,\n \"rum_mobile_replay_session_count_reactnative_sum\": -47431420,\n \"rum_replay_session_count_sum\": -38257628,\n \"rum_session_replay_add_on_sum\": 26265370,\n \"rum_total_session_count_sum\": 63580044,\n \"sca_fargate_count_avg\": -44515303,\n \"sca_fargate_count_hwm\": 42489319,\n \"sds_apm_scanned_bytes_sum\": 38548300,\n \"sds_events_scanned_bytes_sum\": -7832614,\n \"sds_logs_scanned_bytes_sum\": 31365211,\n \"sds_rum_scanned_bytes_sum\": 1500205,\n \"sds_total_scanned_bytes_sum\": -4611451,\n \"serverless_apps_azure_count_avg\": -76498968,\n \"serverless_apps_google_count_avg\": -53538441,\n \"serverless_apps_total_count_avg\": 49453502,\n \"siem_analyzed_logs_add_on_count_sum\": 18813380,\n \"synthetics_browser_check_calls_count_sum\": 83267252,\n \"synthetics_check_calls_count_sum\": 54598576,\n \"synthetics_mobile_test_runs_sum\": -23478478,\n \"synthetics_parallel_testing_max_slots_hwm\": -98010891,\n \"trace_search_indexed_events_count_sum\": 51910365,\n \"twol_ingested_events_bytes_sum\": 31917401,\n \"universal_service_monitoring_host_top99p\": -75968891,\n \"vsphere_host_top99p\": 46884740,\n \"vuln_management_host_count_top99p\": -88815887,\n \"workflow_executions_usage_sum\": 36594734\n }\n ],\n \"product_analytics_sum\": -70803375,\n \"profiling_aas_count_top99p\": 25608544,\n \"profiling_host_top99p\": -27223871,\n \"published_app_hwm\": 50525346,\n \"rum_browser_and_mobile_session_count\": 83076846,\n \"rum_browser_legacy_session_count_sum\": 76695549,\n \"rum_browser_lite_session_count_sum\": 38910513,\n \"rum_browser_replay_session_count_sum\": 50683462,\n \"rum_indexed_sessions_sum\": -59530229,\n \"rum_ingested_sessions_sum\": 62090787,\n \"rum_lite_session_count_sum\": 24185033,\n \"rum_mobile_legacy_session_count_android_sum\": 36645427,\n \"rum_mobile_legacy_session_count_flutter_sum\": 32547714,\n \"rum_mobile_legacy_session_count_ios_sum\": 31822321,\n \"rum_mobile_legacy_session_count_reactnative_sum\": -76686546,\n \"rum_mobile_legacy_session_count_roku_sum\": 18507689,\n \"rum_mobile_lite_session_count_android_sum\": 66530237,\n \"rum_mobile_lite_session_count_flutter_sum\": -15794248,\n \"rum_mobile_lite_session_count_ios_sum\": -8175320,\n \"rum_mobile_lite_session_count_kotlinmultiplatform_sum\": -62683928,\n \"rum_mobile_lite_session_count_reactnative_sum\": 77864938,\n \"rum_mobile_lite_session_count_roku_sum\": -17554174,\n \"rum_mobile_lite_session_count_unity_sum\": -18025112,\n \"rum_mobile_replay_session_count_android_sum\": -63601578,\n \"rum_mobile_replay_session_count_ios_sum\": -87080667,\n \"rum_mobile_replay_session_count_kotlinmultiplatform_sum\": -46972517,\n \"rum_mobile_replay_session_count_reactnative_sum\": 31537871,\n \"rum_replay_session_count_sum\": 6435523,\n \"rum_session_replay_add_on_sum\": -67205646,\n \"rum_total_session_count_sum\": -32044008,\n \"sca_fargate_count_avg\": -86721601,\n \"sca_fargate_count_hwm\": -3293632,\n \"sds_apm_scanned_bytes_sum\": 36044670,\n \"sds_events_scanned_bytes_sum\": 4044132,\n \"sds_logs_scanned_bytes_sum\": 62833414,\n \"sds_rum_scanned_bytes_sum\": -42861929,\n \"sds_total_scanned_bytes_sum\": 56830822,\n \"serverless_apps_azure_count_avg\": 45185442,\n \"serverless_apps_google_count_avg\": -15485043,\n \"serverless_apps_total_count_avg\": -38416529,\n \"siem_analyzed_logs_add_on_count_sum\": -60671913,\n \"synthetics_browser_check_calls_count_sum\": 74135842,\n \"synthetics_check_calls_count_sum\": 23558440,\n \"synthetics_mobile_test_runs_sum\": 39537664,\n \"synthetics_parallel_testing_max_slots_hwm\": -97643250,\n \"trace_search_indexed_events_count_sum\": 55123265,\n \"twol_ingested_events_bytes_sum\": 32993163,\n \"universal_service_monitoring_host_top99p\": -34587554,\n \"vsphere_host_top99p\": -7827770,\n \"vuln_management_host_count_top99p\": -36639253,\n \"workflow_executions_usage_sum\": 98279734\n },\n {\n \"agent_host_top99p\": -94351457,\n \"apm_azure_app_service_host_top99p\": 84197960,\n \"apm_devsecops_host_top99p\": -41975705,\n \"apm_fargate_count_avg\": 76820797,\n \"apm_host_top99p\": 39344258,\n \"appsec_fargate_count_avg\": -61267214,\n \"asm_serverless_sum\": -10917889,\n \"audit_trail_enabled_hwm\": -95030622,\n \"avg_profiled_fargate_tasks\": -28653449,\n \"aws_host_top99p\": 39721616,\n \"aws_lambda_func_count\": -75807560,\n \"aws_lambda_invocations_sum\": -70349893,\n \"azure_app_service_top99p\": 53724508,\n \"billable_ingested_bytes_sum\": -36558400,\n \"browser_rum_replay_session_count_sum\": 17830168,\n \"ci_pipeline_indexed_spans_sum\": -6436512,\n \"ci_test_indexed_spans_sum\": 83010042,\n \"ci_visibility_itr_committers_hwm\": -81180099,\n \"ci_visibility_pipeline_committers_hwm\": 83033839,\n \"ci_visibility_test_committers_hwm\": -10941682,\n \"cloud_cost_management_aws_host_count_avg\": -91087747,\n \"cloud_cost_management_azure_host_count_avg\": 91423987,\n \"cloud_cost_management_gcp_host_count_avg\": 54169577,\n \"cloud_cost_management_host_count_avg\": -49943941,\n \"cloud_siem_events_sum\": -66151935,\n \"code_analysis_sa_committers_hwm\": 37322503,\n \"code_analysis_sca_committers_hwm\": 87885102,\n \"code_security_host_top99p\": 86365846,\n \"container_avg\": -95445156,\n \"container_excl_agent_avg\": 88717974,\n \"container_hwm\": 46509934,\n \"csm_container_enterprise_compliance_count_sum\": -57037877,\n \"csm_container_enterprise_cws_count_sum\": -5575921,\n \"csm_container_enterprise_total_count_sum\": -82235487,\n \"csm_host_enterprise_aas_host_count_top99p\": 12231221,\n \"csm_host_enterprise_aws_host_count_top99p\": -77036004,\n \"csm_host_enterprise_azure_host_count_top99p\": -68434385,\n \"csm_host_enterprise_compliance_host_count_top99p\": 44992780,\n \"csm_host_enterprise_cws_host_count_top99p\": -82191752,\n \"csm_host_enterprise_gcp_host_count_top99p\": -70727254,\n \"csm_host_enterprise_total_host_count_top99p\": -79204537,\n \"cspm_aas_host_top99p\": 26731845,\n \"cspm_aws_host_top99p\": 92451273,\n \"cspm_azure_host_top99p\": -90534793,\n \"cspm_container_avg\": 74089763,\n \"cspm_container_hwm\": 99587640,\n \"cspm_gcp_host_top99p\": 15151969,\n \"cspm_host_top99p\": -87993334,\n \"custom_ts_avg\": -86114177,\n \"cws_container_count_avg\": 95031365,\n \"cws_fargate_task_avg\": 49108410,\n \"cws_host_top99p\": -18890339,\n \"data_jobs_monitoring_host_hr_sum\": 12062759,\n \"date\": \"2022-02-10T06:53:30.029Z\",\n \"dbm_host_top99p\": 59670425,\n \"dbm_queries_count_avg\": -1336053,\n \"eph_infra_host_agent_sum\": -88711536,\n \"eph_infra_host_alibaba_sum\": -23683122,\n \"eph_infra_host_aws_sum\": -39431092,\n \"eph_infra_host_azure_sum\": -43284003,\n \"eph_infra_host_ent_sum\": 49121175,\n \"eph_infra_host_gcp_sum\": 59409903,\n \"eph_infra_host_heroku_sum\": -17951450,\n \"eph_infra_host_only_aas_sum\": 7818891,\n \"eph_infra_host_only_vsphere_sum\": 6731483,\n \"eph_infra_host_opentelemetry_apm_sum\": 35763066,\n \"eph_infra_host_opentelemetry_sum\": 15008918,\n \"eph_infra_host_pro_sum\": -2238554,\n \"eph_infra_host_proplus_sum\": 8697748,\n \"error_tracking_apm_error_events_sum\": 96416737,\n \"error_tracking_error_events_sum\": 31973805,\n \"error_tracking_events_sum\": -66132788,\n \"error_tracking_rum_error_events_sum\": -70562936,\n \"event_management_correlation_correlated_events_sum\": -28367458,\n \"event_management_correlation_correlated_related_events_sum\": 86661658,\n \"event_management_correlation_sum\": 71638988,\n \"fargate_container_profiler_profiling_fargate_avg\": -26055831,\n \"fargate_container_profiler_profiling_fargate_eks_avg\": 84530332,\n \"fargate_tasks_count_avg\": -21158810,\n \"fargate_tasks_count_hwm\": -40029555,\n \"flex_logs_compute_large_avg\": 53947679,\n \"flex_logs_compute_medium_avg\": 78776756,\n \"flex_logs_compute_small_avg\": 8640618,\n \"flex_logs_compute_xlarge_avg\": -10993054,\n \"flex_logs_compute_xsmall_avg\": 6800597,\n \"flex_logs_starter_avg\": -57059447,\n \"flex_logs_starter_storage_index_avg\": 36664147,\n \"flex_logs_starter_storage_retention_adjustment_avg\": 33199576,\n \"flex_stored_logs_avg\": 96199199,\n \"forwarding_events_bytes_sum\": 38277613,\n \"gcp_host_top99p\": 88389348,\n \"heroku_host_top99p\": -80436962,\n \"incident_management_monthly_active_users_hwm\": -28215799,\n \"indexed_events_count_sum\": 13011144,\n \"infra_host_top99p\": 14949117,\n \"ingested_events_bytes_sum\": 53605438,\n \"iot_device_sum\": -39876249,\n \"iot_device_top99p\": -20247074,\n \"llm_observability_min_spend_sum\": -15199163,\n \"llm_observability_sum\": -35107373,\n \"ndm_netflow_events_sum\": -26500478,\n \"network_device_wireless_top99p\": 20030983,\n \"npm_host_top99p\": -59219159,\n \"observability_pipelines_bytes_processed_sum\": -54837189,\n \"oci_host_sum\": 74315682,\n \"oci_host_top99p\": -24390907,\n \"online_archive_events_count_sum\": 31487160,\n \"opentelemetry_apm_host_top99p\": 41158164,\n \"opentelemetry_host_top99p\": -88567242,\n \"orgs\": [\n {\n \"account_name\": \"quis exercitation proident culpa\",\n \"account_public_id\": \"Excepteur\",\n \"agent_host_top99p\": 13148542,\n \"apm_azure_app_service_host_top99p\": 83931891,\n \"apm_devsecops_host_top99p\": -18511873,\n \"apm_fargate_count_avg\": -69678854,\n \"apm_host_top99p\": -33905014,\n \"appsec_fargate_count_avg\": 94976155,\n \"asm_serverless_sum\": 87005692,\n \"audit_trail_enabled_hwm\": 34625618,\n \"avg_profiled_fargate_tasks\": 68325487,\n \"aws_host_top99p\": 2430991,\n \"aws_lambda_func_count\": -60086063,\n \"aws_lambda_invocations_sum\": -50237706,\n \"azure_app_service_top99p\": -57014706,\n \"billable_ingested_bytes_sum\": 6300975,\n \"browser_rum_replay_session_count_sum\": 86886061,\n \"ci_pipeline_indexed_spans_sum\": -99146904,\n \"ci_test_indexed_spans_sum\": 79771521,\n \"ci_visibility_itr_committers_hwm\": -1713830,\n \"ci_visibility_pipeline_committers_hwm\": -66533111,\n \"ci_visibility_test_committers_hwm\": 70568357,\n \"cloud_cost_management_aws_host_count_avg\": 94708792,\n \"cloud_cost_management_azure_host_count_avg\": -38125703,\n \"cloud_cost_management_gcp_host_count_avg\": 47485784,\n \"cloud_cost_management_host_count_avg\": 70783030,\n \"cloud_siem_events_sum\": -28953838,\n \"code_analysis_sa_committers_hwm\": -71700819,\n \"code_analysis_sca_committers_hwm\": 37856893,\n \"code_security_host_top99p\": 50508266,\n \"container_avg\": -16706157,\n \"container_excl_agent_avg\": -87848518,\n \"container_hwm\": 59740943,\n \"csm_container_enterprise_compliance_count_sum\": -34819291,\n \"csm_container_enterprise_cws_count_sum\": -5815992,\n \"csm_container_enterprise_total_count_sum\": -65484462,\n \"csm_host_enterprise_aas_host_count_top99p\": -55540919,\n \"csm_host_enterprise_aws_host_count_top99p\": 23809815,\n \"csm_host_enterprise_azure_host_count_top99p\": 16394378,\n \"csm_host_enterprise_compliance_host_count_top99p\": -20789968,\n \"csm_host_enterprise_cws_host_count_top99p\": 94744658,\n \"csm_host_enterprise_gcp_host_count_top99p\": -5864360,\n \"csm_host_enterprise_total_host_count_top99p\": 33022387,\n \"cspm_aas_host_top99p\": -22398263,\n \"cspm_aws_host_top99p\": -9830634,\n \"cspm_azure_host_top99p\": -37430266,\n \"cspm_container_avg\": -65251273,\n \"cspm_container_hwm\": -98551777,\n \"cspm_gcp_host_top99p\": 79422413,\n \"cspm_host_top99p\": -63724411,\n \"custom_historical_ts_avg\": 44780789,\n \"custom_live_ts_avg\": 31833091,\n \"custom_ts_avg\": -89957627,\n \"cws_container_count_avg\": 19086270,\n \"cws_fargate_task_avg\": 77108243,\n \"cws_host_top99p\": -77818094,\n \"data_jobs_monitoring_host_hr_sum\": 4262223,\n \"dbm_host_top99p_sum\": -33600305,\n \"dbm_queries_avg_sum\": -17757184,\n \"eph_infra_host_agent_sum\": -8060728,\n \"eph_infra_host_alibaba_sum\": 21805359,\n \"eph_infra_host_aws_sum\": 48455549,\n \"eph_infra_host_azure_sum\": -89656181,\n \"eph_infra_host_ent_sum\": -61743515,\n \"eph_infra_host_gcp_sum\": 61257548,\n \"eph_infra_host_heroku_sum\": 20343817,\n \"eph_infra_host_only_aas_sum\": 14840121,\n \"eph_infra_host_only_vsphere_sum\": 67248732,\n \"eph_infra_host_opentelemetry_apm_sum\": 55954822,\n \"eph_infra_host_opentelemetry_sum\": 9640464,\n \"eph_infra_host_pro_sum\": -26070476,\n \"eph_infra_host_proplus_sum\": -22801926,\n \"error_tracking_apm_error_events_sum\": -72509741,\n \"error_tracking_error_events_sum\": -21565782,\n \"error_tracking_events_sum\": 91183582,\n \"error_tracking_rum_error_events_sum\": 57210478,\n \"event_management_correlation_correlated_events_sum\": -13740869,\n \"event_management_correlation_correlated_related_events_sum\": 45546349,\n \"event_management_correlation_sum\": 21946487,\n \"fargate_container_profiler_profiling_fargate_avg\": -46359043,\n \"fargate_container_profiler_profiling_fargate_eks_avg\": -54491745,\n \"fargate_tasks_count_avg\": 99176688,\n \"fargate_tasks_count_hwm\": -80210781,\n \"flex_logs_compute_large_avg\": 56621577,\n \"flex_logs_compute_medium_avg\": 19244126,\n \"flex_logs_compute_small_avg\": 47834074,\n \"flex_logs_compute_xlarge_avg\": 67548980,\n \"flex_logs_compute_xsmall_avg\": -71011088,\n \"flex_logs_starter_avg\": -33616642,\n \"flex_logs_starter_storage_index_avg\": -5950517,\n \"flex_logs_starter_storage_retention_adjustment_avg\": -12580238,\n \"flex_stored_logs_avg\": 50798512,\n \"forwarding_events_bytes_sum\": -54043830,\n \"gcp_host_top99p\": 15305943,\n \"heroku_host_top99p\": -23099988,\n \"id\": \"laboris dolore\",\n \"incident_management_monthly_active_users_hwm\": -99743496,\n \"infra_host_top99p\": -92218160,\n \"ingested_events_bytes_sum\": 91210054,\n \"iot_device_agg_sum\": -86928642,\n \"iot_device_top99p_sum\": -96992823,\n \"llm_observability_min_spend_sum\": -77245571,\n \"llm_observability_sum\": -75812306,\n \"name\": \"voluptate anim sed\",\n \"ndm_netflow_events_sum\": -93459915,\n \"network_device_wireless_top99p\": 77967022,\n \"npm_host_top99p\": 39532456,\n \"observability_pipelines_bytes_processed_sum\": 14223146,\n \"oci_host_sum\": 13456143,\n \"oci_host_top99p\": 96094721,\n \"online_archive_events_count_sum\": 64665156,\n \"opentelemetry_apm_host_top99p\": 73009959,\n \"opentelemetry_host_top99p\": 50235455,\n \"product_analytics_sum\": 25928424,\n \"profiling_aas_count_top99p\": -66237679,\n \"profiling_host_top99p\": 54634602,\n \"public_id\": \"velit voluptate nisi\",\n \"published_app_hwm\": 8459435,\n \"region\": \"pr\",\n \"rum_browser_and_mobile_session_count\": 53044725,\n \"rum_browser_legacy_session_count_sum\": 32133796,\n \"rum_browser_lite_session_count_sum\": 1892506,\n \"rum_browser_replay_session_count_sum\": 49796387,\n \"rum_indexed_sessions_sum\": 53180312,\n \"rum_ingested_sessions_sum\": -66977218,\n \"rum_lite_session_count_sum\": -67143747,\n \"rum_mobile_legacy_session_count_android_sum\": 45021867,\n \"rum_mobile_legacy_session_count_flutter_sum\": 99344800,\n \"rum_mobile_legacy_session_count_ios_sum\": 85011253,\n \"rum_mobile_legacy_session_count_reactnative_sum\": -91650742,\n \"rum_mobile_legacy_session_count_roku_sum\": -66788865,\n \"rum_mobile_lite_session_count_android_sum\": 46291898,\n \"rum_mobile_lite_session_count_flutter_sum\": -7276550,\n \"rum_mobile_lite_session_count_ios_sum\": -52246078,\n \"rum_mobile_lite_session_count_kotlinmultiplatform_sum\": 31300193,\n \"rum_mobile_lite_session_count_reactnative_sum\": -96353642,\n \"rum_mobile_lite_session_count_roku_sum\": -97906536,\n \"rum_mobile_lite_session_count_unity_sum\": 68484187,\n \"rum_mobile_replay_session_count_android_sum\": -42702070,\n \"rum_mobile_replay_session_count_ios_sum\": 19867584,\n \"rum_mobile_replay_session_count_kotlinmultiplatform_sum\": 90489987,\n \"rum_mobile_replay_session_count_reactnative_sum\": 82685882,\n \"rum_replay_session_count_sum\": -15770437,\n \"rum_session_replay_add_on_sum\": 74959321,\n \"rum_total_session_count_sum\": 6067859,\n \"sca_fargate_count_avg\": 94183554,\n \"sca_fargate_count_hwm\": 88271129,\n \"sds_apm_scanned_bytes_sum\": -7071458,\n \"sds_events_scanned_bytes_sum\": -58961158,\n \"sds_logs_scanned_bytes_sum\": 69899297,\n \"sds_rum_scanned_bytes_sum\": 39208067,\n \"sds_total_scanned_bytes_sum\": -55566794,\n \"serverless_apps_azure_count_avg\": 19593660,\n \"serverless_apps_google_count_avg\": 65824549,\n \"serverless_apps_total_count_avg\": 14655459,\n \"siem_analyzed_logs_add_on_count_sum\": -36226593,\n \"synthetics_browser_check_calls_count_sum\": 10795198,\n \"synthetics_check_calls_count_sum\": 51283953,\n \"synthetics_mobile_test_runs_sum\": 72947284,\n \"synthetics_parallel_testing_max_slots_hwm\": -53597919,\n \"trace_search_indexed_events_count_sum\": 43049262,\n \"twol_ingested_events_bytes_sum\": -65248143,\n \"universal_service_monitoring_host_top99p\": -67934329,\n \"vsphere_host_top99p\": 30496182,\n \"vuln_management_host_count_top99p\": -40269445,\n \"workflow_executions_usage_sum\": -25621678\n },\n {\n \"account_name\": \"laboris ut nu\",\n \"account_public_id\": \"ut veniam\",\n \"agent_host_top99p\": 74670473,\n \"apm_azure_app_service_host_top99p\": -64547770,\n \"apm_devsecops_host_top99p\": 2375127,\n \"apm_fargate_count_avg\": -95153035,\n \"apm_host_top99p\": 79433755,\n \"appsec_fargate_count_avg\": 18684444,\n \"asm_serverless_sum\": 62400175,\n \"audit_trail_enabled_hwm\": -36571482,\n \"avg_profiled_fargate_tasks\": 83112620,\n \"aws_host_top99p\": -59210683,\n \"aws_lambda_func_count\": -35195655,\n \"aws_lambda_invocations_sum\": -60285408,\n \"azure_app_service_top99p\": -12357833,\n \"billable_ingested_bytes_sum\": -15840323,\n \"browser_rum_replay_session_count_sum\": -25677345,\n \"ci_pipeline_indexed_spans_sum\": 3354074,\n \"ci_test_indexed_spans_sum\": 34775520,\n \"ci_visibility_itr_committers_hwm\": 2962893,\n \"ci_visibility_pipeline_committers_hwm\": 58920713,\n \"ci_visibility_test_committers_hwm\": -95894436,\n \"cloud_cost_management_aws_host_count_avg\": 83316720,\n \"cloud_cost_management_azure_host_count_avg\": -2486302,\n \"cloud_cost_management_gcp_host_count_avg\": -63432207,\n \"cloud_cost_management_host_count_avg\": 26166204,\n \"cloud_siem_events_sum\": -22549463,\n \"code_analysis_sa_committers_hwm\": 84851138,\n \"code_analysis_sca_committers_hwm\": 24618287,\n \"code_security_host_top99p\": 94049152,\n \"container_avg\": 2797258,\n \"container_excl_agent_avg\": -20226829,\n \"container_hwm\": -69464793,\n \"csm_container_enterprise_compliance_count_sum\": -76306953,\n \"csm_container_enterprise_cws_count_sum\": -86667533,\n \"csm_container_enterprise_total_count_sum\": 52864505,\n \"csm_host_enterprise_aas_host_count_top99p\": -78576897,\n \"csm_host_enterprise_aws_host_count_top99p\": -86705395,\n \"csm_host_enterprise_azure_host_count_top99p\": 60215775,\n \"csm_host_enterprise_compliance_host_count_top99p\": 59640099,\n \"csm_host_enterprise_cws_host_count_top99p\": -81440298,\n \"csm_host_enterprise_gcp_host_count_top99p\": 61974162,\n \"csm_host_enterprise_total_host_count_top99p\": 52390699,\n \"cspm_aas_host_top99p\": -63884431,\n \"cspm_aws_host_top99p\": -62176929,\n \"cspm_azure_host_top99p\": 23302306,\n \"cspm_container_avg\": -24990033,\n \"cspm_container_hwm\": 12610229,\n \"cspm_gcp_host_top99p\": 72823830,\n \"cspm_host_top99p\": -39549246,\n \"custom_historical_ts_avg\": -85205697,\n \"custom_live_ts_avg\": -94909855,\n \"custom_ts_avg\": -54902680,\n \"cws_container_count_avg\": 43877963,\n \"cws_fargate_task_avg\": 6257249,\n \"cws_host_top99p\": 60534058,\n \"data_jobs_monitoring_host_hr_sum\": -70854214,\n \"dbm_host_top99p_sum\": -95778211,\n \"dbm_queries_avg_sum\": -99582395,\n \"eph_infra_host_agent_sum\": -60038232,\n \"eph_infra_host_alibaba_sum\": 45268141,\n \"eph_infra_host_aws_sum\": -54892763,\n \"eph_infra_host_azure_sum\": 58902634,\n \"eph_infra_host_ent_sum\": -84768498,\n \"eph_infra_host_gcp_sum\": 93940447,\n \"eph_infra_host_heroku_sum\": -77381606,\n \"eph_infra_host_only_aas_sum\": 16692909,\n \"eph_infra_host_only_vsphere_sum\": -40167458,\n \"eph_infra_host_opentelemetry_apm_sum\": 3559244,\n \"eph_infra_host_opentelemetry_sum\": 28486433,\n \"eph_infra_host_pro_sum\": -92680791,\n \"eph_infra_host_proplus_sum\": 64251068,\n \"error_tracking_apm_error_events_sum\": 7979786,\n \"error_tracking_error_events_sum\": -39982743,\n \"error_tracking_events_sum\": 39014863,\n \"error_tracking_rum_error_events_sum\": -10954649,\n \"event_management_correlation_correlated_events_sum\": 59371391,\n \"event_management_correlation_correlated_related_events_sum\": -22648664,\n \"event_management_correlation_sum\": -43599166,\n \"fargate_container_profiler_profiling_fargate_avg\": 67685776,\n \"fargate_container_profiler_profiling_fargate_eks_avg\": -94334167,\n \"fargate_tasks_count_avg\": 7674743,\n \"fargate_tasks_count_hwm\": -92624107,\n \"flex_logs_compute_large_avg\": -68110739,\n \"flex_logs_compute_medium_avg\": 81283726,\n \"flex_logs_compute_small_avg\": 43866465,\n \"flex_logs_compute_xlarge_avg\": 43729720,\n \"flex_logs_compute_xsmall_avg\": 13098044,\n \"flex_logs_starter_avg\": 10944076,\n \"flex_logs_starter_storage_index_avg\": 95609575,\n \"flex_logs_starter_storage_retention_adjustment_avg\": -1599394,\n \"flex_stored_logs_avg\": 86807566,\n \"forwarding_events_bytes_sum\": -50910910,\n \"gcp_host_top99p\": -84875804,\n \"heroku_host_top99p\": 13596029,\n \"id\": \"enim l\",\n \"incident_management_monthly_active_users_hwm\": 96140642,\n \"infra_host_top99p\": 95602041,\n \"ingested_events_bytes_sum\": -83024240,\n \"iot_device_agg_sum\": -61677076,\n \"iot_device_top99p_sum\": -91471776,\n \"llm_observability_min_spend_sum\": -98632895,\n \"llm_observability_sum\": 29695219,\n \"name\": \"magn\",\n \"ndm_netflow_events_sum\": 76718517,\n \"network_device_wireless_top99p\": -54265831,\n \"npm_host_top99p\": 74687024,\n \"observability_pipelines_bytes_processed_sum\": 616736,\n \"oci_host_sum\": 49378894,\n \"oci_host_top99p\": -11999418,\n \"online_archive_events_count_sum\": 60446277,\n \"opentelemetry_apm_host_top99p\": -14626466,\n \"opentelemetry_host_top99p\": 21230120,\n \"product_analytics_sum\": 60172936,\n \"profiling_aas_count_top99p\": -72735710,\n \"profiling_host_top99p\": -68456482,\n \"public_id\": \"eu non Lorem\",\n \"published_app_hwm\": -44980547,\n \"region\": \"ea velit Ut\",\n \"rum_browser_and_mobile_session_count\": 91001295,\n \"rum_browser_legacy_session_count_sum\": -40254681,\n \"rum_browser_lite_session_count_sum\": 89459399,\n \"rum_browser_replay_session_count_sum\": -98471673,\n \"rum_indexed_sessions_sum\": 85815901,\n \"rum_ingested_sessions_sum\": 61717682,\n \"rum_lite_session_count_sum\": 56761464,\n \"rum_mobile_legacy_session_count_android_sum\": -11139009,\n \"rum_mobile_legacy_session_count_flutter_sum\": -4644442,\n \"rum_mobile_legacy_session_count_ios_sum\": -73781529,\n \"rum_mobile_legacy_session_count_reactnative_sum\": 16900321,\n \"rum_mobile_legacy_session_count_roku_sum\": -60105330,\n \"rum_mobile_lite_session_count_android_sum\": 70010166,\n \"rum_mobile_lite_session_count_flutter_sum\": -92113633,\n \"rum_mobile_lite_session_count_ios_sum\": 9754617,\n \"rum_mobile_lite_session_count_kotlinmultiplatform_sum\": 46958600,\n \"rum_mobile_lite_session_count_reactnative_sum\": 15491289,\n \"rum_mobile_lite_session_count_roku_sum\": -10628421,\n \"rum_mobile_lite_session_count_unity_sum\": 79296564,\n \"rum_mobile_replay_session_count_android_sum\": -23205173,\n \"rum_mobile_replay_session_count_ios_sum\": -89559497,\n \"rum_mobile_replay_session_count_kotlinmultiplatform_sum\": 21739856,\n \"rum_mobile_replay_session_count_reactnative_sum\": -45546300,\n \"rum_replay_session_count_sum\": 61105190,\n \"rum_session_replay_add_on_sum\": -49819423,\n \"rum_total_session_count_sum\": 68308834,\n \"sca_fargate_count_avg\": 72240446,\n \"sca_fargate_count_hwm\": -32787430,\n \"sds_apm_scanned_bytes_sum\": 92174945,\n \"sds_events_scanned_bytes_sum\": -68396561,\n \"sds_logs_scanned_bytes_sum\": 21445773,\n \"sds_rum_scanned_bytes_sum\": -32744720,\n \"sds_total_scanned_bytes_sum\": 37797994,\n \"serverless_apps_azure_count_avg\": 63666512,\n \"serverless_apps_google_count_avg\": -62088334,\n \"serverless_apps_total_count_avg\": 55629359,\n \"siem_analyzed_logs_add_on_count_sum\": 26614299,\n \"synthetics_browser_check_calls_count_sum\": -29038735,\n \"synthetics_check_calls_count_sum\": 14078020,\n \"synthetics_mobile_test_runs_sum\": -17404391,\n \"synthetics_parallel_testing_max_slots_hwm\": 45049392,\n \"trace_search_indexed_events_count_sum\": -98639270,\n \"twol_ingested_events_bytes_sum\": 30380160,\n \"universal_service_monitoring_host_top99p\": -48461610,\n \"vsphere_host_top99p\": 47438179,\n \"vuln_management_host_count_top99p\": 61866657,\n \"workflow_executions_usage_sum\": -2416281\n }\n ],\n \"product_analytics_sum\": -96816575,\n \"profiling_aas_count_top99p\": 33200495,\n \"profiling_host_top99p\": -11470616,\n \"published_app_hwm\": 50816196,\n \"rum_browser_and_mobile_session_count\": 41006916,\n \"rum_browser_legacy_session_count_sum\": -41891963,\n \"rum_browser_lite_session_count_sum\": -56082398,\n \"rum_browser_replay_session_count_sum\": 90517319,\n \"rum_indexed_sessions_sum\": 78598458,\n \"rum_ingested_sessions_sum\": 54891424,\n \"rum_lite_session_count_sum\": 31271770,\n \"rum_mobile_legacy_session_count_android_sum\": 61597461,\n \"rum_mobile_legacy_session_count_flutter_sum\": -78078907,\n \"rum_mobile_legacy_session_count_ios_sum\": 71868813,\n \"rum_mobile_legacy_session_count_reactnative_sum\": 98651459,\n \"rum_mobile_legacy_session_count_roku_sum\": 60901237,\n \"rum_mobile_lite_session_count_android_sum\": 44147928,\n \"rum_mobile_lite_session_count_flutter_sum\": 62714516,\n \"rum_mobile_lite_session_count_ios_sum\": 8978798,\n \"rum_mobile_lite_session_count_kotlinmultiplatform_sum\": -80253630,\n \"rum_mobile_lite_session_count_reactnative_sum\": 95744281,\n \"rum_mobile_lite_session_count_roku_sum\": 66983172,\n \"rum_mobile_lite_session_count_unity_sum\": -690436,\n \"rum_mobile_replay_session_count_android_sum\": 48358113,\n \"rum_mobile_replay_session_count_ios_sum\": -32011358,\n \"rum_mobile_replay_session_count_kotlinmultiplatform_sum\": -47879566,\n \"rum_mobile_replay_session_count_reactnative_sum\": 59383056,\n \"rum_replay_session_count_sum\": -15333867,\n \"rum_session_replay_add_on_sum\": -35041690,\n \"rum_total_session_count_sum\": -80582020,\n \"sca_fargate_count_avg\": -39225012,\n \"sca_fargate_count_hwm\": 13553856,\n \"sds_apm_scanned_bytes_sum\": 88367903,\n \"sds_events_scanned_bytes_sum\": -11725372,\n \"sds_logs_scanned_bytes_sum\": 30839012,\n \"sds_rum_scanned_bytes_sum\": 41070134,\n \"sds_total_scanned_bytes_sum\": 50818063,\n \"serverless_apps_azure_count_avg\": -1922238,\n \"serverless_apps_google_count_avg\": -21926033,\n \"serverless_apps_total_count_avg\": -56249700,\n \"siem_analyzed_logs_add_on_count_sum\": 6772057,\n \"synthetics_browser_check_calls_count_sum\": 87354562,\n \"synthetics_check_calls_count_sum\": -15810572,\n \"synthetics_mobile_test_runs_sum\": -53151456,\n \"synthetics_parallel_testing_max_slots_hwm\": -97065519,\n \"trace_search_indexed_events_count_sum\": -28977898,\n \"twol_ingested_events_bytes_sum\": 49936157,\n \"universal_service_monitoring_host_top99p\": -5371873,\n \"vsphere_host_top99p\": -55264816,\n \"vuln_management_host_count_top99p\": -9188954,\n \"workflow_executions_usage_sum\": 47333132\n }\n ],\n \"vsphere_host_top99p_sum\": 87033735,\n \"vuln_management_host_count_top99p_sum\": 37688251,\n \"workflow_executions_usage_agg_sum\": -62358440\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/summary?start_month=1993-10-23T16:56:47.315Z&end_month=1993-10-23T16:56:47.315Z&include_org_details=true&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"summary"
],
"query": [
{
"key": "start_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month.\nMaximum of 15 months ago."
},
{
"key": "end_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month."
},
{
"key": "include_org_details",
"value": "true",
"description": "Include usage summaries for each sub-org."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden - User is not authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/summary?start_month=1993-10-23T16:56:47.315Z&end_month=1993-10-23T16:56:47.315Z&include_org_details=true&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"summary"
],
"query": [
{
"key": "start_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month.\nMaximum of 15 months ago."
},
{
"key": "end_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month."
},
{
"key": "include_org_details",
"value": "true",
"description": "Include usage summaries for each sub-org."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/summary?start_month=1993-10-23T16:56:47.315Z&end_month=1993-10-23T16:56:47.315Z&include_org_details=true&include_connected_accounts=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"summary"
],
"query": [
{
"key": "start_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month.\nMaximum of 15 months ago."
},
{
"key": "end_month",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month."
},
{
"key": "include_org_details",
"value": "true",
"description": "Include usage summaries for each sub-org."
},
{
"key": "include_connected_accounts",
"value": "false",
"description": "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`. "
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get hourly usage for logs by index",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/logs_by_index?start_hr=1993-10-23T16:56:47.315Z&end_hr=1993-10-23T16:56:47.315Z&index_name=cupidatat sit irure&index_name=Ut qui Excepteur",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"logs_by_index"
],
"query": [
{
"key": "start_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
},
{
"key": "index_name",
"value": "cupidatat sit irure",
"description": "Comma-separated list of log index names."
},
{
"key": "index_name",
"value": "Ut qui Excepteur",
"description": "Comma-separated list of log index names."
}
]
},
"description": "Get hourly usage for logs by index."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/logs_by_index?start_hr=1993-10-23T16:56:47.315Z&end_hr=1993-10-23T16:56:47.315Z&index_name=Ut qui Excepteur",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"logs_by_index"
],
"query": [
{
"key": "start_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
},
{
"key": "index_name",
"value": "Ut qui Excepteur",
"description": "Comma-separated list of log index names."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"usage\": [\n {\n \"event_count\": -74661244,\n \"hour\": \"2009-11-20T01:04:00.804Z\",\n \"index_id\": \"magna minim\",\n \"index_name\": \"aute mollit\",\n \"org_name\": \"non reprehenderit officia\",\n \"public_id\": \"ipsum ex occaecat\",\n \"retention\": -46174632\n },\n {\n \"event_count\": -14939378,\n \"hour\": \"2011-11-06T20:52:37.609Z\",\n \"index_id\": \"minim aliquip\",\n \"index_name\": \"pariatur qui dol\",\n \"org_name\": \"nulla in ad\",\n \"public_id\": \"magna\",\n \"retention\": 62307530\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/logs_by_index?start_hr=1993-10-23T16:56:47.315Z&end_hr=1993-10-23T16:56:47.315Z&index_name=Ut qui Excepteur",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"logs_by_index"
],
"query": [
{
"key": "start_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
},
{
"key": "index_name",
"value": "Ut qui Excepteur",
"description": "Comma-separated list of log index names."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden - User is not authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/logs_by_index?start_hr=1993-10-23T16:56:47.315Z&end_hr=1993-10-23T16:56:47.315Z&index_name=Ut qui Excepteur",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"logs_by_index"
],
"query": [
{
"key": "start_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
},
{
"key": "index_name",
"value": "Ut qui Excepteur",
"description": "Comma-separated list of log index names."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/logs_by_index?start_hr=1993-10-23T16:56:47.315Z&end_hr=1993-10-23T16:56:47.315Z&index_name=Ut qui Excepteur",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"logs_by_index"
],
"query": [
{
"key": "start_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1993-10-23T16:56:47.315Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
},
{
"key": "index_name",
"value": "Ut qui Excepteur",
"description": "Comma-separated list of log index names."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "The usage metering API allows you to get hourly, daily, and\nmonthly usage across multiple facets of Datadog.\nThis API is available to all Pro and Enterprise customers.\n\n**Note**: Usage data is delayed by up to 72 hours from when it was incurred.\nIt is retained for 15 months.\n\nYou can retrieve up to 24 hours of hourly usage data for multiple organizations,\nand up to two months of hourly usage data for a single organization in one request.\nLearn more on the [usage details documentation](https://docs.datadoghq.com/account_management/billing/usage_details/).",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Users",
"item": [
{
"name": "Create a user",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"email\": \"jane.doe@example.com\",\n \"name\": \"amet laboris an\",\n \"title\": \"consequat do dolore ipsum quis\"\n },\n \"type\": \"users\",\n \"relationships\": {\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
]
},
"description": "Create a user for your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"email\": \"jane.doe@example.com\",\n \"name\": \"amet laboris an\",\n \"title\": \"consequat do dolore ipsum quis\"\n },\n \"type\": \"users\",\n \"relationships\": {\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"2005-12-14T18:17:57.666Z\",\n \"disabled\": false,\n \"email\": \"quis nulla dolor ullamco\",\n \"handle\": \"magna aute Excepteur cillum qui\",\n \"icon\": \"eu occaecat anim \",\n \"modified_at\": \"1990-12-01T02:41:26.199Z\",\n \"name\": \"voluptate Ut cillum minim\",\n \"service_account\": false,\n \"status\": \"Duis pariatur\",\n \"title\": \"sunt irure et\",\n \"verified\": true\n },\n \"id\": \"sit veniam velit ipsum dolore\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n \"included\": [\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"1989-01-21T18:12:19.298Z\",\n \"description\": \"culpa commodo adipisicing in\",\n \"disabled\": false,\n \"modified_at\": \"1951-10-29T07:06:58.474Z\",\n \"name\": \"veniam in nisi cillum irure\",\n \"public_id\": \"Ut esse pariatur\",\n \"sharing\": \"nisi laborum ut aliqua\",\n \"url\": \"sint ea quis sit\"\n },\n \"id\": \"ut exe\"\n },\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"1997-09-29T04:11:37.259Z\",\n \"description\": \"ullamco mollit occaecat in anim\",\n \"disabled\": false,\n \"modified_at\": \"2020-02-24T20:19:57.938Z\",\n \"name\": \"reprehenderit Ut dolore minim\",\n \"public_id\": \"do qui ad laborum\",\n \"sharing\": \"enim deserunt cillum\",\n \"url\": \"aliquip id\"\n },\n \"id\": \"voluptate sunt ad incididunt\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"email\": \"jane.doe@example.com\",\n \"name\": \"amet laboris an\",\n \"title\": \"consequat do dolore ipsum quis\"\n },\n \"type\": \"users\",\n \"relationships\": {\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"email\": \"jane.doe@example.com\",\n \"name\": \"amet laboris an\",\n \"title\": \"consequat do dolore ipsum quis\"\n },\n \"type\": \"users\",\n \"relationships\": {\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"email\": \"jane.doe@example.com\",\n \"name\": \"amet laboris an\",\n \"title\": \"consequat do dolore ipsum quis\"\n },\n \"type\": \"users\",\n \"relationships\": {\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "List all users",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is ascending by default.\nSort order is descending if the field\nis prefixed by a negative sign, for example `sort=-name`. Options: `name`,\n`modified_at`, `user_count`.",
"disabled": true
},
{
"key": "sort_dir",
"value": "desc",
"description": "Direction of sort. Options: `asc`, `desc`.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all users by the given string. Defaults to no filtering.",
"disabled": true
},
{
"key": "filter[status]",
"value": "Active",
"description": "Filter on status attribute.\nComma separated list, with possible values `Active`, `Pending`, and `Disabled`.\nDefaults to no filtering.",
"disabled": true
}
]
},
"description": "Get the list of all users in the organization. This list includes\nall users even if they are deactivated or unverified."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is ascending by default.\nSort order is descending if the field\nis prefixed by a negative sign, for example `sort=-name`. Options: `name`,\n`modified_at`, `user_count`.",
"disabled": true
},
{
"key": "sort_dir",
"value": "desc",
"description": "Direction of sort. Options: `asc`, `desc`.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all users by the given string. Defaults to no filtering.",
"disabled": true
},
{
"key": "filter[status]",
"value": "Active",
"description": "Filter on status attribute.\nComma separated list, with possible values `Active`, `Pending`, and `Disabled`.\nDefaults to no filtering.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"2016-06-21T01:04:16.799Z\",\n \"disabled\": true,\n \"email\": \"laborum labore nulla\",\n \"handle\": \"sed anim ipsum\",\n \"icon\": \"elit nisi dolore Excepteur ut\",\n \"modified_at\": \"1987-05-21T03:58:08.624Z\",\n \"name\": \"Lorem\",\n \"service_account\": false,\n \"status\": \"consequat Ut aliquip\",\n \"title\": \"aliqua tempor\",\n \"verified\": false\n },\n \"id\": \"adipisicing Duis\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2019-02-23T06:01:44.457Z\",\n \"disabled\": false,\n \"email\": \"sint eiusmod Ut consequat\",\n \"handle\": \"occaecat ullamco incididunt eu\",\n \"icon\": \"Ut dolor\",\n \"modified_at\": \"1946-04-15T11:31:03.027Z\",\n \"name\": \"non id\",\n \"service_account\": true,\n \"status\": \"Excepteur D\",\n \"title\": \"mollit in aute anim proident\",\n \"verified\": true\n },\n \"id\": \"ei\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ],\n \"included\": [\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"1957-02-12T18:48:25.171Z\",\n \"description\": \"consequat in commodo adipisicing\",\n \"disabled\": true,\n \"modified_at\": \"2005-01-30T19:04:56.267Z\",\n \"name\": \"consequat sit\",\n \"public_id\": \"tempor consequat proident\",\n \"sharing\": \"cillum proident incididunt\",\n \"url\": \"a\"\n },\n \"id\": \"eiusmod ut Lorem fugiat\"\n },\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"2015-10-18T08:46:20.466Z\",\n \"description\": \"in ut\",\n \"disabled\": true,\n \"modified_at\": \"1979-12-20T09:40:53.251Z\",\n \"name\": \"mollit irure ad ipsum\",\n \"public_id\": \"dolor id\",\n \"sharing\": \"elit nulla\",\n \"url\": \"nisi in\"\n },\n \"id\": \"deserunt amet\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": -17566972,\n \"total_filtered_count\": 91760735\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is ascending by default.\nSort order is descending if the field\nis prefixed by a negative sign, for example `sort=-name`. Options: `name`,\n`modified_at`, `user_count`.",
"disabled": true
},
{
"key": "sort_dir",
"value": "desc",
"description": "Direction of sort. Options: `asc`, `desc`.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all users by the given string. Defaults to no filtering.",
"disabled": true
},
{
"key": "filter[status]",
"value": "Active",
"description": "Filter on status attribute.\nComma separated list, with possible values `Active`, `Pending`, and `Disabled`.\nDefaults to no filtering.",
"disabled": true
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is ascending by default.\nSort order is descending if the field\nis prefixed by a negative sign, for example `sort=-name`. Options: `name`,\n`modified_at`, `user_count`.",
"disabled": true
},
{
"key": "sort_dir",
"value": "desc",
"description": "Direction of sort. Options: `asc`, `desc`.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all users by the given string. Defaults to no filtering.",
"disabled": true
},
{
"key": "filter[status]",
"value": "Active",
"description": "Filter on status attribute.\nComma separated list, with possible values `Active`, `Pending`, and `Disabled`.\nDefaults to no filtering.",
"disabled": true
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100.",
"disabled": true
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return.",
"disabled": true
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is ascending by default.\nSort order is descending if the field\nis prefixed by a negative sign, for example `sort=-name`. Options: `name`,\n`modified_at`, `user_count`.",
"disabled": true
},
{
"key": "sort_dir",
"value": "desc",
"description": "Direction of sort. Options: `asc`, `desc`.",
"disabled": true
},
{
"key": "filter",
"value": "pariatur consequat",
"description": "Filter all users by the given string. Defaults to no filtering.",
"disabled": true
},
{
"key": "filter[status]",
"value": "Active",
"description": "Filter on status attribute.\nComma separated list, with possible values `Active`, `Pending`, and `Disabled`.\nDefaults to no filtering.",
"disabled": true
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get user details",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id",
"value": "00000000-0000-9999-0000-000000000000"
}
]
},
"description": "Get a user in the organization specified by the user’s `user_id`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"2005-12-14T18:17:57.666Z\",\n \"disabled\": false,\n \"email\": \"quis nulla dolor ullamco\",\n \"handle\": \"magna aute Excepteur cillum qui\",\n \"icon\": \"eu occaecat anim \",\n \"modified_at\": \"1990-12-01T02:41:26.199Z\",\n \"name\": \"voluptate Ut cillum minim\",\n \"service_account\": false,\n \"status\": \"Duis pariatur\",\n \"title\": \"sunt irure et\",\n \"verified\": true\n },\n \"id\": \"sit veniam velit ipsum dolore\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n \"included\": [\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"1989-01-21T18:12:19.298Z\",\n \"description\": \"culpa commodo adipisicing in\",\n \"disabled\": false,\n \"modified_at\": \"1951-10-29T07:06:58.474Z\",\n \"name\": \"veniam in nisi cillum irure\",\n \"public_id\": \"Ut esse pariatur\",\n \"sharing\": \"nisi laborum ut aliqua\",\n \"url\": \"sint ea quis sit\"\n },\n \"id\": \"ut exe\"\n },\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"1997-09-29T04:11:37.259Z\",\n \"description\": \"ullamco mollit occaecat in anim\",\n \"disabled\": false,\n \"modified_at\": \"2020-02-24T20:19:57.938Z\",\n \"name\": \"reprehenderit Ut dolore minim\",\n \"public_id\": \"do qui ad laborum\",\n \"sharing\": \"enim deserunt cillum\",\n \"url\": \"aliquip id\"\n },\n \"id\": \"voluptate sunt ad incididunt\"\n }\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a user",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"disabled\": false,\n \"email\": \"ut aliquip deserunt anim\",\n \"name\": \"elit ut anim in\"\n },\n \"type\": \"users\",\n \"id\": \"00000000-0000-feed-0000-000000000000\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id",
"value": "00000000-0000-9999-0000-000000000000"
}
]
},
"description": "Edit a user. Can only be used with an application key belonging\nto an administrator user."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"disabled\": false,\n \"email\": \"ut aliquip deserunt anim\",\n \"name\": \"elit ut anim in\"\n },\n \"type\": \"users\",\n \"id\": \"00000000-0000-feed-0000-000000000000\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"2005-12-14T18:17:57.666Z\",\n \"disabled\": false,\n \"email\": \"quis nulla dolor ullamco\",\n \"handle\": \"magna aute Excepteur cillum qui\",\n \"icon\": \"eu occaecat anim \",\n \"modified_at\": \"1990-12-01T02:41:26.199Z\",\n \"name\": \"voluptate Ut cillum minim\",\n \"service_account\": false,\n \"status\": \"Duis pariatur\",\n \"title\": \"sunt irure et\",\n \"verified\": true\n },\n \"id\": \"sit veniam velit ipsum dolore\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n \"included\": [\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"1989-01-21T18:12:19.298Z\",\n \"description\": \"culpa commodo adipisicing in\",\n \"disabled\": false,\n \"modified_at\": \"1951-10-29T07:06:58.474Z\",\n \"name\": \"veniam in nisi cillum irure\",\n \"public_id\": \"Ut esse pariatur\",\n \"sharing\": \"nisi laborum ut aliqua\",\n \"url\": \"sint ea quis sit\"\n },\n \"id\": \"ut exe\"\n },\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"1997-09-29T04:11:37.259Z\",\n \"description\": \"ullamco mollit occaecat in anim\",\n \"disabled\": false,\n \"modified_at\": \"2020-02-24T20:19:57.938Z\",\n \"name\": \"reprehenderit Ut dolore minim\",\n \"public_id\": \"do qui ad laborum\",\n \"sharing\": \"enim deserunt cillum\",\n \"url\": \"aliquip id\"\n },\n \"id\": \"voluptate sunt ad incididunt\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"disabled\": false,\n \"email\": \"ut aliquip deserunt anim\",\n \"name\": \"elit ut anim in\"\n },\n \"type\": \"users\",\n \"id\": \"00000000-0000-feed-0000-000000000000\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"disabled\": false,\n \"email\": \"ut aliquip deserunt anim\",\n \"name\": \"elit ut anim in\"\n },\n \"type\": \"users\",\n \"id\": \"00000000-0000-feed-0000-000000000000\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"disabled\": false,\n \"email\": \"ut aliquip deserunt anim\",\n \"name\": \"elit ut anim in\"\n },\n \"type\": \"users\",\n \"id\": \"00000000-0000-feed-0000-000000000000\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Unprocessable Entity",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"disabled\": false,\n \"email\": \"ut aliquip deserunt anim\",\n \"name\": \"elit ut anim in\"\n },\n \"type\": \"users\",\n \"id\": \"00000000-0000-feed-0000-000000000000\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"disabled\": false,\n \"email\": \"ut aliquip deserunt anim\",\n \"name\": \"elit ut anim in\"\n },\n \"type\": \"users\",\n \"id\": \"00000000-0000-feed-0000-000000000000\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Disable a user",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id",
"value": "00000000-0000-9999-0000-000000000000"
}
]
},
"description": "Disable a user. Can only be used with an application key belonging\nto an administrator user."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Authentication error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a user organization",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/orgs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"orgs"
],
"variable": [
{
"key": "user_id",
"value": "00000000-0000-9999-0000-000000000000"
}
]
},
"description": "Get a user organization. Returns the user information and all organizations\njoined by this user."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/orgs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"orgs"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"2005-12-14T18:17:57.666Z\",\n \"disabled\": false,\n \"email\": \"quis nulla dolor ullamco\",\n \"handle\": \"magna aute Excepteur cillum qui\",\n \"icon\": \"eu occaecat anim \",\n \"modified_at\": \"1990-12-01T02:41:26.199Z\",\n \"name\": \"voluptate Ut cillum minim\",\n \"service_account\": false,\n \"status\": \"Duis pariatur\",\n \"title\": \"sunt irure et\",\n \"verified\": true\n },\n \"id\": \"sit veniam velit ipsum dolore\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"00000000-0000-beef-0000-000000000000\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": []\n },\n \"other_users\": {\n \"data\": []\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n \"included\": [\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"1989-01-21T18:12:19.298Z\",\n \"description\": \"culpa commodo adipisicing in\",\n \"disabled\": false,\n \"modified_at\": \"1951-10-29T07:06:58.474Z\",\n \"name\": \"veniam in nisi cillum irure\",\n \"public_id\": \"Ut esse pariatur\",\n \"sharing\": \"nisi laborum ut aliqua\",\n \"url\": \"sint ea quis sit\"\n },\n \"id\": \"ut exe\"\n },\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"1997-09-29T04:11:37.259Z\",\n \"description\": \"ullamco mollit occaecat in anim\",\n \"disabled\": false,\n \"modified_at\": \"2020-02-24T20:19:57.938Z\",\n \"name\": \"reprehenderit Ut dolore minim\",\n \"public_id\": \"do qui ad laborum\",\n \"sharing\": \"enim deserunt cillum\",\n \"url\": \"aliquip id\"\n },\n \"id\": \"voluptate sunt ad incididunt\"\n }\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/orgs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"orgs"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/orgs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"orgs"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/orgs",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"orgs"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a user permissions",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"permissions"
],
"variable": [
{
"key": "user_id",
"value": "00000000-0000-9999-0000-000000000000"
}
]
},
"description": "Get a user permission set. Returns a list of the user’s permissions\ngranted by the associated user's roles."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"permissions"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"type\": \"permissions\",\n \"attributes\": {\n \"created\": \"1972-03-11T01:22:33.040Z\",\n \"description\": \"officia quis qui Excepteur\",\n \"display_name\": \"anim sint velit aute et\",\n \"display_type\": \"aliquip voluptate eu in\",\n \"group_name\": \"dolor cillum labore ma\",\n \"name\": \"culpa veniam\",\n \"restricted\": true\n },\n \"id\": \"dolore occaecat laboris non\"\n },\n {\n \"type\": \"permissions\",\n \"attributes\": {\n \"created\": \"2020-04-07T16:00:13.055Z\",\n \"description\": \"Duis mollit occaecat\",\n \"display_name\": \"in dolor elit\",\n \"display_type\": \"sed \",\n \"group_name\": \"ut dolore Lorem\",\n \"name\": \"nulla\",\n \"restricted\": true\n },\n \"id\": \"commodo non labore\"\n }\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"permissions"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"permissions"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"permissions"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Send invitation emails",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations"
]
},
"description": "Sends emails to one or more users inviting them to join the organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"1961-12-17T17:35:53.740Z\",\n \"expires_at\": \"1948-08-29T19:36:34.237Z\",\n \"invite_type\": \"magna laborum\",\n \"uuid\": \"esse\"\n },\n \"id\": \"quis sed sunt dolore\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"user_invitations\"\n },\n {\n \"attributes\": {\n \"created_at\": \"2000-06-21T13:44:03.437Z\",\n \"expires_at\": \"1994-11-16T07:55:31.791Z\",\n \"invite_type\": \"do\",\n \"uuid\": \"su\"\n },\n \"id\": \"sunt cons\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"user_invitations\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a user invitation",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations/:user_invitation_uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations",
":user_invitation_uuid"
],
"variable": [
{
"key": "user_invitation_uuid",
"value": "00000000-0000-0000-3456-000000000000"
}
]
},
"description": "Returns a single user invitation by its UUID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations/:user_invitation_uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations",
":user_invitation_uuid"
],
"variable": [
{
"key": "user_invitation_uuid"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"1962-01-06T05:56:56.441Z\",\n \"expires_at\": \"2014-01-24T18:54:59.761Z\",\n \"invite_type\": \"nisi in\",\n \"uuid\": \"Excepteur ipsum eu ma\"\n },\n \"id\": \"ad\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"00000000-0000-0000-2345-000000000000\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"user_invitations\"\n }\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations/:user_invitation_uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations",
":user_invitation_uuid"
],
"variable": [
{
"key": "user_invitation_uuid"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations/:user_invitation_uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations",
":user_invitation_uuid"
],
"variable": [
{
"key": "user_invitation_uuid"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations/:user_invitation_uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations",
":user_invitation_uuid"
],
"variable": [
{
"key": "user_invitation_uuid"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Create, edit, and disable users.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Webhooks Integration",
"item": [
{
"name": "Create a webhooks integration",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"WEBHOOK_NAME\",\n \"url\": \"https://example.com/webhook\",\n \"custom_headers\": \"veniam eiusmod\",\n \"encode_as\": \"json\",\n \"payload\": \"veniam do ea proident\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks"
]
},
"description": "Creates an endpoint with the name `<WEBHOOK_NAME>`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"WEBHOOK_NAME\",\n \"url\": \"https://example.com/webhook\",\n \"custom_headers\": \"veniam eiusmod\",\n \"encode_as\": \"json\",\n \"payload\": \"veniam do ea proident\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"WEBHOOK_NAME\",\n \"url\": \"https://example.com/webhook\",\n \"custom_headers\": \"veniam eiusmod\",\n \"encode_as\": \"json\",\n \"payload\": \"veniam do ea proident\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"WEBHOOK_NAME\",\n \"url\": \"https://example.com/webhook\",\n \"custom_headers\": \"veniam eiusmod\",\n \"encode_as\": \"json\",\n \"payload\": \"veniam do ea proident\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"WEBHOOK_NAME\",\n \"url\": \"https://example.com/webhook\",\n \"custom_headers\": \"veniam eiusmod\",\n \"encode_as\": \"json\",\n \"payload\": \"veniam do ea proident\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"WEBHOOK_NAME\",\n \"url\": \"https://example.com/webhook\",\n \"custom_headers\": \"veniam eiusmod\",\n \"encode_as\": \"json\",\n \"payload\": \"veniam do ea proident\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a webhook integration",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name",
"value": "pariatur"
}
]
},
"description": "Gets the content of the webhook with the name `<WEBHOOK_NAME>`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"WEBHOOK_NAME\",\n \"url\": \"https://example.com/webhook\",\n \"custom_headers\": \"veniam eiusmod\",\n \"encode_as\": \"json\",\n \"payload\": \"veniam do ea proident\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a webhook",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_headers\": \"ullamco aute \",\n \"encode_as\": \"json\",\n \"name\": \"WEBHOOK_NAME\",\n \"payload\": \"aliqua enim sint ut\",\n \"url\": \"https://example.com/webhook\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name",
"value": "pariatur"
}
]
},
"description": "Updates the endpoint with the name `<WEBHOOK_NAME>`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_headers\": \"ullamco aute \",\n \"encode_as\": \"json\",\n \"name\": \"WEBHOOK_NAME\",\n \"payload\": \"aliqua enim sint ut\",\n \"url\": \"https://example.com/webhook\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"WEBHOOK_NAME\",\n \"url\": \"https://example.com/webhook\",\n \"custom_headers\": \"veniam eiusmod\",\n \"encode_as\": \"json\",\n \"payload\": \"veniam do ea proident\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_headers\": \"ullamco aute \",\n \"encode_as\": \"json\",\n \"name\": \"WEBHOOK_NAME\",\n \"payload\": \"aliqua enim sint ut\",\n \"url\": \"https://example.com/webhook\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_headers\": \"ullamco aute \",\n \"encode_as\": \"json\",\n \"name\": \"WEBHOOK_NAME\",\n \"payload\": \"aliqua enim sint ut\",\n \"url\": \"https://example.com/webhook\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_headers\": \"ullamco aute \",\n \"encode_as\": \"json\",\n \"name\": \"WEBHOOK_NAME\",\n \"payload\": \"aliqua enim sint ut\",\n \"url\": \"https://example.com/webhook\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_headers\": \"ullamco aute \",\n \"encode_as\": \"json\",\n \"name\": \"WEBHOOK_NAME\",\n \"payload\": \"aliqua enim sint ut\",\n \"url\": \"https://example.com/webhook\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a webhook",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name",
"value": "pariatur"
}
]
},
"description": "Deletes the endpoint with the name `<WEBHOOK NAME>`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Authentication error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Create a custom variable",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\",\n \"is_secret\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables"
]
},
"description": "Creates an endpoint with the name `<CUSTOM_VARIABLE_NAME>`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\",\n \"is_secret\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"is_secret\": true,\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\",\n \"is_secret\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\",\n \"is_secret\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\",\n \"is_secret\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a custom variable",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name",
"value": "pariatur"
}
]
},
"description": "Shows the content of the custom variable with the name `<CUSTOM_VARIABLE_NAME>`.\n\nIf the custom variable is secret, the value does not return in the\nresponse payload."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"is_secret\": true,\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Update a custom variable",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"is_secret\": true,\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name",
"value": "pariatur"
}
]
},
"description": "Updates the endpoint with the name `<CUSTOM_VARIABLE_NAME>`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"is_secret\": true,\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"is_secret\": true,\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"is_secret\": true,\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"is_secret\": true,\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"is_secret\": true,\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"is_secret\": true,\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Delete a custom variable",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name",
"value": "pariatur"
}
]
},
"description": "Deletes the endpoint with the name `<CUSTOM_VARIABLE_NAME>`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Authentication error",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Configure your Datadog-Webhooks integration directly through the Datadog API.\nSee the [Webhooks integration page](https://docs.datadoghq.com/integrations/webhooks) for more information.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
},
{
"name": "Workflow Automation",
"item": [
{
"name": "Get an existing Workflow",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id",
"value": "proident amet voluptate"
}
]
},
"description": "Get a workflow by ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key)."
},
"response": [
{
"name": "Successfully got a workflow.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"workflows\",\n \"attributes\": {\n \"name\": \"\",\n \"spec\": {\n \"annotations\": [\n {\n \"id\": \"\",\n \"display\": {\n \"bounds\": {\n \"height\": -1486217.1346578598,\n \"width\": 93142545.16862518,\n \"x\": 44617655.42219412,\n \"y\": -42965604.13737938\n }\n },\n \"markdownTextAnnotation\": {\n \"text\": \"aute non ex voluptate\"\n }\n },\n {\n \"id\": \"\",\n \"display\": {\n \"bounds\": {\n \"height\": 68724734.93370274,\n \"width\": 81157229.52916977,\n \"x\": -73043041.290999,\n \"y\": 9830175.2075793\n }\n },\n \"markdownTextAnnotation\": {\n \"text\": \"in aliquip ut\"\n }\n }\n ],\n \"connectionEnvs\": [\n {\n \"env\": \"default\",\n \"connectionGroups\": [\n {\n \"connectionGroupId\": \"\",\n \"label\": \"\",\n \"tags\": [\n \"\"\n ]\n },\n {\n \"connectionGroupId\": \"\",\n \"label\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"connections\": [\n {\n \"connectionId\": \"\",\n \"label\": \"\"\n },\n {\n \"connectionId\": \"\",\n \"label\": \"\"\n }\n ]\n },\n {\n \"env\": \"default\",\n \"connectionGroups\": [\n {\n \"connectionGroupId\": \"\",\n \"label\": \"\",\n \"tags\": [\n \"\"\n ]\n },\n {\n \"connectionGroupId\": \"\",\n \"label\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"connections\": [\n {\n \"connectionId\": \"\",\n \"label\": \"\"\n },\n {\n \"connectionId\": \"\",\n \"label\": \"\"\n }\n ]\n }\n ],\n \"handle\": \"eu ut dolore\",\n \"inputSchema\": {\n \"parameters\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"defaultValue\": {\n \"description\": \"The `InputSchemaParameters` `defaultValue`.\"\n },\n \"description\": \"elit commodo irure pariatur\",\n \"label\": \"quis ut sint magna\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"defaultValue\": {\n \"description\": \"The `InputSchemaParameters` `defaultValue`.\"\n },\n \"description\": \"consequa\",\n \"label\": \"aliquip amet cupidatat\"\n }\n ]\n },\n \"outputSchema\": {\n \"parameters\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"defaultValue\": {\n \"description\": \"The `OutputSchemaParameters` `defaultValue`.\"\n },\n \"description\": \"quis pariatur\",\n \"label\": \"sint dolore officia enim dolore\",\n \"value\": {\n \"description\": \"The `OutputSchemaParameters` `value`.\"\n }\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"defaultValue\": {\n \"description\": \"The `OutputSchemaParameters` `defaultValue`.\"\n },\n \"description\": \"dolore in irure nulla\",\n \"label\": \"qui sit tempor\",\n \"value\": {\n \"description\": \"The `OutputSchemaParameters` `value`.\"\n }\n }\n ]\n },\n \"steps\": [\n {\n \"name\": \"\",\n \"actionId\": \"\",\n \"completionGate\": {\n \"completionCondition\": {\n \"operand1\": {\n \"description\": \"The `CompletionCondition` `operand1`.\"\n },\n \"operator\": \"OPERATOR_EQUAL\",\n \"operand2\": {\n \"description\": \"The `CompletionCondition` `operand2`.\"\n }\n },\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n }\n },\n \"connectionLabel\": \"nulla aliquip\",\n \"display\": {\n \"bounds\": {\n \"x\": -32933093.736147344,\n \"y\": -9654278.184199944\n }\n },\n \"errorHandlers\": [\n {\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n },\n \"fallbackStepName\": \"\"\n },\n {\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n },\n \"fallbackStepName\": \"\"\n }\n ],\n \"outboundEdges\": [\n {\n \"nextStepName\": \"\",\n \"branchName\": \"\"\n },\n {\n \"nextStepName\": \"\",\n \"branchName\": \"\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": {\n \"description\": \"The `Parameter` `value`.\"\n }\n },\n {\n \"name\": \"\",\n \"value\": {\n \"description\": \"The `Parameter` `value`.\"\n }\n }\n ],\n \"readinessGate\": {\n \"thresholdType\": \"ANY\"\n }\n },\n {\n \"name\": \"\",\n \"actionId\": \"\",\n \"completionGate\": {\n \"completionCondition\": {\n \"operand1\": {\n \"description\": \"The `CompletionCondition` `operand1`.\"\n },\n \"operator\": \"OPERATOR_EQUAL\",\n \"operand2\": {\n \"description\": \"The `CompletionCondition` `operand2`.\"\n }\n },\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n }\n },\n \"connectionLabel\": \"eiusmod cillum\",\n \"display\": {\n \"bounds\": {\n \"x\": -79414362.61096802,\n \"y\": -19489860.978954747\n }\n },\n \"errorHandlers\": [\n {\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n },\n \"fallbackStepName\": \"\"\n },\n {\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n },\n \"fallbackStepName\": \"\"\n }\n ],\n \"outboundEdges\": [\n {\n \"nextStepName\": \"\",\n \"branchName\": \"\"\n },\n {\n \"nextStepName\": \"\",\n \"branchName\": \"\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": {\n \"description\": \"The `Parameter` `value`.\"\n }\n },\n {\n \"name\": \"\",\n \"value\": {\n \"description\": \"The `Parameter` `value`.\"\n }\n }\n ],\n \"readinessGate\": {\n \"thresholdType\": \"ANY\"\n }\n }\n ],\n \"triggers\": [\n {\n \"apiTrigger\": {\n \"rateLimit\": {\n \"count\": 20014897,\n \"interval\": \"aliqua do\"\n }\n },\n \"startStepNames\": [\n \"\"\n ]\n },\n {\n \"apiTrigger\": {\n \"rateLimit\": {\n \"count\": -89601122,\n \"interval\": \"Ut consequat do\"\n }\n },\n \"startStepNames\": [\n \"\"\n ]\n }\n ]\n },\n \"createdAt\": \"2011-05-26T11:34:51.739Z\",\n \"description\": \"ad Duis nostrud sed\",\n \"published\": true,\n \"tags\": [\n \"exercitat\",\n \"pariatur in cupidatat Duis\"\n ],\n \"updatedAt\": \"1981-02-13T19:33:35.078Z\",\n \"webhookSecret\": \"ex\"\n },\n \"id\": \"sunt Excepteur\",\n \"relationships\": {\n \"creator\": {\n \"data\": {\n \"type\": \"users\",\n \"id\": \"\"\n }\n },\n \"owner\": {\n \"data\": {\n \"type\": \"users\",\n \"id\": \"\"\n }\n }\n }\n }\n}"
},
{
"name": "Bad request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"anim0\": {},\n \"cillum_4c2\": {},\n \"consecteture3\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sed_690\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"anim0\": {},\n \"cillum_4c2\": {},\n \"consecteture3\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sed_690\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"anim0\": {},\n \"cillum_4c2\": {},\n \"consecteture3\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sed_690\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"anim0\": {},\n \"cillum_4c2\": {},\n \"consecteture3\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sed_690\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
},
{
"name": "Create a Workflow",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"A sample workflow.\",\n \"name\": \"Example Workflow\",\n \"published\": true,\n \"spec\": {\n \"annotations\": [\n {\n \"display\": {\n \"bounds\": {\n \"height\": 150,\n \"width\": 300,\n \"x\": -375,\n \"y\": -0.5\n }\n },\n \"id\": \"99999999-9999-9999-9999-999999999999\",\n \"markdownTextAnnotation\": {\n \"text\": \"Example annotation.\"\n }\n }\n ],\n \"connectionEnvs\": [\n {\n \"connections\": [\n {\n \"connectionId\": \"11111111-1111-1111-1111-111111111111\",\n \"label\": \"INTEGRATION_DATADOG\"\n }\n ],\n \"env\": \"default\"\n }\n ],\n \"handle\": \"my-handle\",\n \"inputSchema\": {\n \"parameters\": [\n {\n \"defaultValue\": \"default\",\n \"name\": \"input\",\n \"type\": \"STRING\"\n }\n ]\n },\n \"outputSchema\": {\n \"parameters\": [\n {\n \"name\": \"output\",\n \"type\": \"ARRAY_OBJECT\",\n \"value\": \"{{ Steps.Step1 }}\"\n }\n ]\n },\n \"steps\": [\n {\n \"actionId\": \"com.datadoghq.dd.monitor.listMonitors\",\n \"connectionLabel\": \"INTEGRATION_DATADOG\",\n \"name\": \"Step1\",\n \"outboundEdges\": [\n {\n \"branchName\": \"main\",\n \"nextStepName\": \"Step2\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"tags\",\n \"value\": \"service:monitoring\"\n }\n ]\n },\n {\n \"actionId\": \"com.datadoghq.core.noop\",\n \"name\": \"Step2\"\n }\n ],\n \"triggers\": [\n {\n \"monitorTrigger\": {\n \"rateLimit\": {\n \"count\": 1,\n \"interval\": \"3600s\"\n }\n },\n \"startStepNames\": [\n \"Step1\"\n ]\n },\n {\n \"githubWebhookTrigger\": {},\n \"startStepNames\": [\n \"Step1\"\n ]\n }\n ]\n },\n \"tags\": [\n \"team:infra\",\n \"service:monitoring\",\n \"foo:bar\"\n ]\n },\n \"type\": \"workflows\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows"
]
},
"description": "Create a new workflow, returning the workflow ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key)."
},
"response": [
{
"name": "Successfully created a workflow.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"A sample workflow.\",\n \"name\": \"Example Workflow\",\n \"published\": true,\n \"spec\": {\n \"annotations\": [\n {\n \"display\": {\n \"bounds\": {\n \"height\": 150,\n \"width\": 300,\n \"x\": -375,\n \"y\": -0.5\n }\n },\n \"id\": \"99999999-9999-9999-9999-999999999999\",\n \"markdownTextAnnotation\": {\n \"text\": \"Example annotation.\"\n }\n }\n ],\n \"connectionEnvs\": [\n {\n \"connections\": [\n {\n \"connectionId\": \"11111111-1111-1111-1111-111111111111\",\n \"label\": \"INTEGRATION_DATADOG\"\n }\n ],\n \"env\": \"default\"\n }\n ],\n \"handle\": \"my-handle\",\n \"inputSchema\": {\n \"parameters\": [\n {\n \"defaultValue\": \"default\",\n \"name\": \"input\",\n \"type\": \"STRING\"\n }\n ]\n },\n \"outputSchema\": {\n \"parameters\": [\n {\n \"name\": \"output\",\n \"type\": \"ARRAY_OBJECT\",\n \"value\": \"{{ Steps.Step1 }}\"\n }\n ]\n },\n \"steps\": [\n {\n \"actionId\": \"com.datadoghq.dd.monitor.listMonitors\",\n \"connectionLabel\": \"INTEGRATION_DATADOG\",\n \"name\": \"Step1\",\n \"outboundEdges\": [\n {\n \"branchName\": \"main\",\n \"nextStepName\": \"Step2\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"tags\",\n \"value\": \"service:monitoring\"\n }\n ]\n },\n {\n \"actionId\": \"com.datadoghq.core.noop\",\n \"name\": \"Step2\"\n }\n ],\n \"triggers\": [\n {\n \"monitorTrigger\": {\n \"rateLimit\": {\n \"count\": 1,\n \"interval\": \"3600s\"\n }\n },\n \"startStepNames\": [\n \"Step1\"\n ]\n },\n {\n \"githubWebhookTrigger\": {},\n \"startStepNames\": [\n \"Step1\"\n ]\n }\n ]\n },\n \"tags\": [\n \"team:infra\",\n \"service:monitoring\",\n \"foo:bar\"\n ]\n },\n \"type\": \"workflows\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"workflows\",\n \"attributes\": {\n \"name\": \"\",\n \"spec\": {\n \"annotations\": [\n {\n \"id\": \"\",\n \"display\": {\n \"bounds\": {\n \"height\": 43772765.62819916,\n \"width\": 21601062.641619787,\n \"x\": -13232114.80019845,\n \"y\": -75191653.9191099\n }\n },\n \"markdownTextAnnotation\": {\n \"text\": \"velit exer\"\n }\n },\n {\n \"id\": \"\",\n \"display\": {\n \"bounds\": {\n \"height\": 81899032.25382489,\n \"width\": 78693312.49437416,\n \"x\": -12323443.36398241,\n \"y\": -62619856.132090576\n }\n },\n \"markdownTextAnnotation\": {\n \"text\": \"culpa velit Excepteur\"\n }\n }\n ],\n \"connectionEnvs\": [\n {\n \"env\": \"default\",\n \"connectionGroups\": [\n {\n \"connectionGroupId\": \"\",\n \"label\": \"\",\n \"tags\": [\n \"\"\n ]\n },\n {\n \"connectionGroupId\": \"\",\n \"label\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"connections\": [\n {\n \"connectionId\": \"\",\n \"label\": \"\"\n },\n {\n \"connectionId\": \"\",\n \"label\": \"\"\n }\n ]\n },\n {\n \"env\": \"default\",\n \"connectionGroups\": [\n {\n \"connectionGroupId\": \"\",\n \"label\": \"\",\n \"tags\": [\n \"\"\n ]\n },\n {\n \"connectionGroupId\": \"\",\n \"label\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"connections\": [\n {\n \"connectionId\": \"\",\n \"label\": \"\"\n },\n {\n \"connectionId\": \"\",\n \"label\": \"\"\n }\n ]\n }\n ],\n \"handle\": \"ea fugiat\",\n \"inputSchema\": {\n \"parameters\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"defaultValue\": {\n \"description\": \"The `InputSchemaParameters` `defaultValue`.\"\n },\n \"description\": \"aute reprehenderit Duis quis\",\n \"label\": \"exercitation\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"defaultValue\": {\n \"description\": \"The `InputSchemaParameters` `defaultValue`.\"\n },\n \"description\": \"ullamco commodo aute Lorem\",\n \"label\": \"ad et\"\n }\n ]\n },\n \"outputSchema\": {\n \"parameters\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"defaultValue\": {\n \"description\": \"The `OutputSchemaParameters` `defaultValue`.\"\n },\n \"description\": \"Lorem voluptate\",\n \"label\": \"Excepteur irure proident\",\n \"value\": {\n \"description\": \"The `OutputSchemaParameters` `value`.\"\n }\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"defaultValue\": {\n \"description\": \"The `OutputSchemaParameters` `defaultValue`.\"\n },\n \"description\": \"consectetu\",\n \"label\": \"dolore mollit\",\n \"value\": {\n \"description\": \"The `OutputSchemaParameters` `value`.\"\n }\n }\n ]\n },\n \"steps\": [\n {\n \"name\": \"\",\n \"actionId\": \"\",\n \"completionGate\": {\n \"completionCondition\": {\n \"operand1\": {\n \"description\": \"The `CompletionCondition` `operand1`.\"\n },\n \"operator\": \"OPERATOR_EQUAL\",\n \"operand2\": {\n \"description\": \"The `CompletionCondition` `operand2`.\"\n }\n },\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n }\n },\n \"connectionLabel\": \"consectetur labore dolor\",\n \"display\": {\n \"bounds\": {\n \"x\": -63409442.07256438,\n \"y\": -69162755.32209975\n }\n },\n \"errorHandlers\": [\n {\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n },\n \"fallbackStepName\": \"\"\n },\n {\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n },\n \"fallbackStepName\": \"\"\n }\n ],\n \"outboundEdges\": [\n {\n \"nextStepName\": \"\",\n \"branchName\": \"\"\n },\n {\n \"nextStepName\": \"\",\n \"branchName\": \"\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": {\n \"description\": \"The `Parameter` `value`.\"\n }\n },\n {\n \"name\": \"\",\n \"value\": {\n \"description\": \"The `Parameter` `value`.\"\n }\n }\n ],\n \"readinessGate\": {\n \"thresholdType\": \"ANY\"\n }\n },\n {\n \"name\": \"\",\n \"actionId\": \"\",\n \"completionGate\": {\n \"completionCondition\": {\n \"operand1\": {\n \"description\": \"The `CompletionCondition` `operand1`.\"\n },\n \"operator\": \"OPERATOR_EQUAL\",\n \"operand2\": {\n \"description\": \"The `CompletionCondition` `operand2`.\"\n }\n },\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n }\n },\n \"connectionLabel\": \"id voluptate\",\n \"display\": {\n \"bounds\": {\n \"x\": -10152608.511935577,\n \"y\": 68553107.57521266\n }\n },\n \"errorHandlers\": [\n {\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n },\n \"fallbackStepName\": \"\"\n },\n {\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n },\n \"fallbackStepName\": \"\"\n }\n ],\n \"outboundEdges\": [\n {\n \"nextStepName\": \"\",\n \"branchName\": \"\"\n },\n {\n \"nextStepName\": \"\",\n \"branchName\": \"\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": {\n \"description\": \"The `Parameter` `value`.\"\n }\n },\n {\n \"name\": \"\",\n \"value\": {\n \"description\": \"The `Parameter` `value`.\"\n }\n }\n ],\n \"readinessGate\": {\n \"thresholdType\": \"ANY\"\n }\n }\n ],\n \"triggers\": [\n {\n \"apiTrigger\": {\n \"rateLimit\": {\n \"count\": -1460502,\n \"interval\": \"dolor ut culpa magna dolor\"\n }\n },\n \"startStepNames\": [\n \"\"\n ]\n },\n {\n \"apiTrigger\": {\n \"rateLimit\": {\n \"count\": -57317138,\n \"interval\": \"dolore deserunt laborum mollit Duis\"\n }\n },\n \"startStepNames\": [\n \"\"\n ]\n }\n ]\n },\n \"createdAt\": \"1954-04-04T14:37:33.534Z\",\n \"description\": \"consectetur aliquip culpa Excepteur est\",\n \"published\": false,\n \"tags\": [\n \"ut eiusmod Duis fugiat\",\n \"ea ullamco voluptate mollit\"\n ],\n \"updatedAt\": \"1949-12-22T21:48:55.619Z\",\n \"webhookSecret\": \"dolor ut Duis\"\n },\n \"id\": \"aliquip qui in\",\n \"relationships\": {\n \"creator\": {\n \"data\": {\n \"type\": \"users\",\n \"id\": \"\"\n }\n },\n \"owner\": {\n \"data\": {\n \"type\": \"users\",\n \"id\": \"\"\n }\n }\n }\n }\n}"
},
{
"name": "Bad request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"A sample workflow.\",\n \"name\": \"Example Workflow\",\n \"published\": true,\n \"spec\": {\n \"annotations\": [\n {\n \"display\": {\n \"bounds\": {\n \"height\": 150,\n \"width\": 300,\n \"x\": -375,\n \"y\": -0.5\n }\n },\n \"id\": \"99999999-9999-9999-9999-999999999999\",\n \"markdownTextAnnotation\": {\n \"text\": \"Example annotation.\"\n }\n }\n ],\n \"connectionEnvs\": [\n {\n \"connections\": [\n {\n \"connectionId\": \"11111111-1111-1111-1111-111111111111\",\n \"label\": \"INTEGRATION_DATADOG\"\n }\n ],\n \"env\": \"default\"\n }\n ],\n \"handle\": \"my-handle\",\n \"inputSchema\": {\n \"parameters\": [\n {\n \"defaultValue\": \"default\",\n \"name\": \"input\",\n \"type\": \"STRING\"\n }\n ]\n },\n \"outputSchema\": {\n \"parameters\": [\n {\n \"name\": \"output\",\n \"type\": \"ARRAY_OBJECT\",\n \"value\": \"{{ Steps.Step1 }}\"\n }\n ]\n },\n \"steps\": [\n {\n \"actionId\": \"com.datadoghq.dd.monitor.listMonitors\",\n \"connectionLabel\": \"INTEGRATION_DATADOG\",\n \"name\": \"Step1\",\n \"outboundEdges\": [\n {\n \"branchName\": \"main\",\n \"nextStepName\": \"Step2\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"tags\",\n \"value\": \"service:monitoring\"\n }\n ]\n },\n {\n \"actionId\": \"com.datadoghq.core.noop\",\n \"name\": \"Step2\"\n }\n ],\n \"triggers\": [\n {\n \"monitorTrigger\": {\n \"rateLimit\": {\n \"count\": 1,\n \"interval\": \"3600s\"\n }\n },\n \"startStepNames\": [\n \"Step1\"\n ]\n },\n {\n \"githubWebhookTrigger\": {},\n \"startStepNames\": [\n \"Step1\"\n ]\n }\n ]\n },\n \"tags\": [\n \"team:infra\",\n \"service:monitoring\",\n \"foo:bar\"\n ]\n },\n \"type\": \"workflows\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"anim0\": {},\n \"cillum_4c2\": {},\n \"consecteture3\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sed_690\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"A sample workflow.\",\n \"name\": \"Example Workflow\",\n \"published\": true,\n \"spec\": {\n \"annotations\": [\n {\n \"display\": {\n \"bounds\": {\n \"height\": 150,\n \"width\": 300,\n \"x\": -375,\n \"y\": -0.5\n }\n },\n \"id\": \"99999999-9999-9999-9999-999999999999\",\n \"markdownTextAnnotation\": {\n \"text\": \"Example annotation.\"\n }\n }\n ],\n \"connectionEnvs\": [\n {\n \"connections\": [\n {\n \"connectionId\": \"11111111-1111-1111-1111-111111111111\",\n \"label\": \"INTEGRATION_DATADOG\"\n }\n ],\n \"env\": \"default\"\n }\n ],\n \"handle\": \"my-handle\",\n \"inputSchema\": {\n \"parameters\": [\n {\n \"defaultValue\": \"default\",\n \"name\": \"input\",\n \"type\": \"STRING\"\n }\n ]\n },\n \"outputSchema\": {\n \"parameters\": [\n {\n \"name\": \"output\",\n \"type\": \"ARRAY_OBJECT\",\n \"value\": \"{{ Steps.Step1 }}\"\n }\n ]\n },\n \"steps\": [\n {\n \"actionId\": \"com.datadoghq.dd.monitor.listMonitors\",\n \"connectionLabel\": \"INTEGRATION_DATADOG\",\n \"name\": \"Step1\",\n \"outboundEdges\": [\n {\n \"branchName\": \"main\",\n \"nextStepName\": \"Step2\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"tags\",\n \"value\": \"service:monitoring\"\n }\n ]\n },\n {\n \"actionId\": \"com.datadoghq.core.noop\",\n \"name\": \"Step2\"\n }\n ],\n \"triggers\": [\n {\n \"monitorTrigger\": {\n \"rateLimit\": {\n \"count\": 1,\n \"interval\": \"3600s\"\n }\n },\n \"startStepNames\": [\n \"Step1\"\n ]\n },\n {\n \"githubWebhookTrigger\": {},\n \"startStepNames\": [\n \"Step1\"\n ]\n }\n ]\n },\n \"tags\": [\n \"team:infra\",\n \"service:monitoring\",\n \"foo:bar\"\n ]\n },\n \"type\": \"workflows\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"anim0\": {},\n \"cillum_4c2\": {},\n \"consecteture3\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sed_690\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"A sample workflow.\",\n \"name\": \"Example Workflow\",\n \"published\": true,\n \"spec\": {\n \"annotations\": [\n {\n \"display\": {\n \"bounds\": {\n \"height\": 150,\n \"width\": 300,\n \"x\": -375,\n \"y\": -0.5\n }\n },\n \"id\": \"99999999-9999-9999-9999-999999999999\",\n \"markdownTextAnnotation\": {\n \"text\": \"Example annotation.\"\n }\n }\n ],\n \"connectionEnvs\": [\n {\n \"connections\": [\n {\n \"connectionId\": \"11111111-1111-1111-1111-111111111111\",\n \"label\": \"INTEGRATION_DATADOG\"\n }\n ],\n \"env\": \"default\"\n }\n ],\n \"handle\": \"my-handle\",\n \"inputSchema\": {\n \"parameters\": [\n {\n \"defaultValue\": \"default\",\n \"name\": \"input\",\n \"type\": \"STRING\"\n }\n ]\n },\n \"outputSchema\": {\n \"parameters\": [\n {\n \"name\": \"output\",\n \"type\": \"ARRAY_OBJECT\",\n \"value\": \"{{ Steps.Step1 }}\"\n }\n ]\n },\n \"steps\": [\n {\n \"actionId\": \"com.datadoghq.dd.monitor.listMonitors\",\n \"connectionLabel\": \"INTEGRATION_DATADOG\",\n \"name\": \"Step1\",\n \"outboundEdges\": [\n {\n \"branchName\": \"main\",\n \"nextStepName\": \"Step2\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"tags\",\n \"value\": \"service:monitoring\"\n }\n ]\n },\n {\n \"actionId\": \"com.datadoghq.core.noop\",\n \"name\": \"Step2\"\n }\n ],\n \"triggers\": [\n {\n \"monitorTrigger\": {\n \"rateLimit\": {\n \"count\": 1,\n \"interval\": \"3600s\"\n }\n },\n \"startStepNames\": [\n \"Step1\"\n ]\n },\n {\n \"githubWebhookTrigger\": {},\n \"startStepNames\": [\n \"Step1\"\n ]\n }\n ]\n },\n \"tags\": [\n \"team:infra\",\n \"service:monitoring\",\n \"foo:bar\"\n ]\n },\n \"type\": \"workflows\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"anim0\": {},\n \"cillum_4c2\": {},\n \"consecteture3\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sed_690\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
},
{
"name": "Update an existing Workflow",
"request": {
"auth": {
"type": "noauth"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"A sample workflow.\",\n \"name\": \"Example Workflow\",\n \"published\": true,\n \"spec\": {\n \"annotations\": [\n {\n \"display\": {\n \"bounds\": {\n \"height\": 150,\n \"width\": 300,\n \"x\": -375,\n \"y\": -0.5\n }\n },\n \"id\": \"99999999-9999-9999-9999-999999999999\",\n \"markdownTextAnnotation\": {\n \"text\": \"Example annotation.\"\n }\n }\n ],\n \"connectionEnvs\": [\n {\n \"connections\": [\n {\n \"connectionId\": \"11111111-1111-1111-1111-111111111111\",\n \"label\": \"INTEGRATION_DATADOG\"\n }\n ],\n \"env\": \"default\"\n }\n ],\n \"handle\": \"my-handle\",\n \"inputSchema\": {\n \"parameters\": [\n {\n \"defaultValue\": \"default\",\n \"name\": \"input\",\n \"type\": \"STRING\"\n }\n ]\n },\n \"outputSchema\": {\n \"parameters\": [\n {\n \"name\": \"output\",\n \"type\": \"ARRAY_OBJECT\",\n \"value\": \"{{ Steps.Step1 }}\"\n }\n ]\n },\n \"steps\": [\n {\n \"actionId\": \"com.datadoghq.dd.monitor.listMonitors\",\n \"connectionLabel\": \"INTEGRATION_DATADOG\",\n \"name\": \"Step1\",\n \"outboundEdges\": [\n {\n \"branchName\": \"main\",\n \"nextStepName\": \"Step2\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"tags\",\n \"value\": \"service:monitoring\"\n }\n ]\n },\n {\n \"actionId\": \"com.datadoghq.core.noop\",\n \"name\": \"Step2\"\n }\n ],\n \"triggers\": [\n {\n \"monitorTrigger\": {\n \"rateLimit\": {\n \"count\": 1,\n \"interval\": \"3600s\"\n }\n },\n \"startStepNames\": [\n \"Step1\"\n ]\n },\n {\n \"githubWebhookTrigger\": {},\n \"startStepNames\": [\n \"Step1\"\n ]\n }\n ]\n },\n \"tags\": [\n \"team:infra\",\n \"service:monitoring\",\n \"foo:bar\"\n ]\n },\n \"id\": \"22222222-2222-2222-2222-222222222222\",\n \"type\": \"workflows\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id",
"value": "proident amet voluptate"
}
]
},
"description": "Update a workflow by ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key)."
},
"response": [
{
"name": "Successfully updated a workflow.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"A sample workflow.\",\n \"name\": \"Example Workflow\",\n \"published\": true,\n \"spec\": {\n \"annotations\": [\n {\n \"display\": {\n \"bounds\": {\n \"height\": 150,\n \"width\": 300,\n \"x\": -375,\n \"y\": -0.5\n }\n },\n \"id\": \"99999999-9999-9999-9999-999999999999\",\n \"markdownTextAnnotation\": {\n \"text\": \"Example annotation.\"\n }\n }\n ],\n \"connectionEnvs\": [\n {\n \"connections\": [\n {\n \"connectionId\": \"11111111-1111-1111-1111-111111111111\",\n \"label\": \"INTEGRATION_DATADOG\"\n }\n ],\n \"env\": \"default\"\n }\n ],\n \"handle\": \"my-handle\",\n \"inputSchema\": {\n \"parameters\": [\n {\n \"defaultValue\": \"default\",\n \"name\": \"input\",\n \"type\": \"STRING\"\n }\n ]\n },\n \"outputSchema\": {\n \"parameters\": [\n {\n \"name\": \"output\",\n \"type\": \"ARRAY_OBJECT\",\n \"value\": \"{{ Steps.Step1 }}\"\n }\n ]\n },\n \"steps\": [\n {\n \"actionId\": \"com.datadoghq.dd.monitor.listMonitors\",\n \"connectionLabel\": \"INTEGRATION_DATADOG\",\n \"name\": \"Step1\",\n \"outboundEdges\": [\n {\n \"branchName\": \"main\",\n \"nextStepName\": \"Step2\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"tags\",\n \"value\": \"service:monitoring\"\n }\n ]\n },\n {\n \"actionId\": \"com.datadoghq.core.noop\",\n \"name\": \"Step2\"\n }\n ],\n \"triggers\": [\n {\n \"monitorTrigger\": {\n \"rateLimit\": {\n \"count\": 1,\n \"interval\": \"3600s\"\n }\n },\n \"startStepNames\": [\n \"Step1\"\n ]\n },\n {\n \"githubWebhookTrigger\": {},\n \"startStepNames\": [\n \"Step1\"\n ]\n }\n ]\n },\n \"tags\": [\n \"team:infra\",\n \"service:monitoring\",\n \"foo:bar\"\n ]\n },\n \"id\": \"22222222-2222-2222-2222-222222222222\",\n \"type\": \"workflows\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"type\": \"workflows\",\n \"attributes\": {\n \"createdAt\": \"1952-04-04T11:28:50.122Z\",\n \"description\": \"Ut Duis\",\n \"name\": \"cupidatat\",\n \"published\": true,\n \"spec\": {\n \"annotations\": [\n {\n \"id\": \"\",\n \"display\": {\n \"bounds\": {\n \"height\": -48707117.686056465,\n \"width\": 25041401.774858102,\n \"x\": 69979372.84610844,\n \"y\": -96203933.22538972\n }\n },\n \"markdownTextAnnotation\": {\n \"text\": \"non consectetur deserunt amet\"\n }\n },\n {\n \"id\": \"\",\n \"display\": {\n \"bounds\": {\n \"height\": -6070446.856386319,\n \"width\": 75701123.55390325,\n \"x\": -80970505.01039517,\n \"y\": 81318379.49649662\n }\n },\n \"markdownTextAnnotation\": {\n \"text\": \"ut\"\n }\n }\n ],\n \"connectionEnvs\": [\n {\n \"env\": \"default\",\n \"connectionGroups\": [\n {\n \"connectionGroupId\": \"\",\n \"label\": \"\",\n \"tags\": [\n \"\"\n ]\n },\n {\n \"connectionGroupId\": \"\",\n \"label\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"connections\": [\n {\n \"connectionId\": \"\",\n \"label\": \"\"\n },\n {\n \"connectionId\": \"\",\n \"label\": \"\"\n }\n ]\n },\n {\n \"env\": \"default\",\n \"connectionGroups\": [\n {\n \"connectionGroupId\": \"\",\n \"label\": \"\",\n \"tags\": [\n \"\"\n ]\n },\n {\n \"connectionGroupId\": \"\",\n \"label\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"connections\": [\n {\n \"connectionId\": \"\",\n \"label\": \"\"\n },\n {\n \"connectionId\": \"\",\n \"label\": \"\"\n }\n ]\n }\n ],\n \"handle\": \"incididunt Ut officia id cupidatat\",\n \"inputSchema\": {\n \"parameters\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"defaultValue\": {\n \"description\": \"The `InputSchemaParameters` `defaultValue`.\"\n },\n \"description\": \"Duis do proident\",\n \"label\": \"consequat aliqua in\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"defaultValue\": {\n \"description\": \"The `InputSchemaParameters` `defaultValue`.\"\n },\n \"description\": \"nisi irure\",\n \"label\": \"ipsum\"\n }\n ]\n },\n \"outputSchema\": {\n \"parameters\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"defaultValue\": {\n \"description\": \"The `OutputSchemaParameters` `defaultValue`.\"\n },\n \"description\": \"tempor dolore quis\",\n \"label\": \"Excepteur in magna\",\n \"value\": {\n \"description\": \"The `OutputSchemaParameters` `value`.\"\n }\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"defaultValue\": {\n \"description\": \"The `OutputSchemaParameters` `defaultValue`.\"\n },\n \"description\": \"minim eu dolor\",\n \"label\": \"fugiat\",\n \"value\": {\n \"description\": \"The `OutputSchemaParameters` `value`.\"\n }\n }\n ]\n },\n \"steps\": [\n {\n \"name\": \"\",\n \"actionId\": \"\",\n \"completionGate\": {\n \"completionCondition\": {\n \"operand1\": {\n \"description\": \"The `CompletionCondition` `operand1`.\"\n },\n \"operator\": \"OPERATOR_EQUAL\",\n \"operand2\": {\n \"description\": \"The `CompletionCondition` `operand2`.\"\n }\n },\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n }\n },\n \"connectionLabel\": \"officia labore amet id in\",\n \"display\": {\n \"bounds\": {\n \"x\": -23209325.024766117,\n \"y\": -32098188.893592954\n }\n },\n \"errorHandlers\": [\n {\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n },\n \"fallbackStepName\": \"\"\n },\n {\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n },\n \"fallbackStepName\": \"\"\n }\n ],\n \"outboundEdges\": [\n {\n \"nextStepName\": \"\",\n \"branchName\": \"\"\n },\n {\n \"nextStepName\": \"\",\n \"branchName\": \"\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": {\n \"description\": \"The `Parameter` `value`.\"\n }\n },\n {\n \"name\": \"\",\n \"value\": {\n \"description\": \"The `Parameter` `value`.\"\n }\n }\n ],\n \"readinessGate\": {\n \"thresholdType\": \"ANY\"\n }\n },\n {\n \"name\": \"\",\n \"actionId\": \"\",\n \"completionGate\": {\n \"completionCondition\": {\n \"operand1\": {\n \"description\": \"The `CompletionCondition` `operand1`.\"\n },\n \"operator\": \"OPERATOR_EQUAL\",\n \"operand2\": {\n \"description\": \"The `CompletionCondition` `operand2`.\"\n }\n },\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n }\n },\n \"connectionLabel\": \"cupidatat consectetur elit\",\n \"display\": {\n \"bounds\": {\n \"x\": -765587.0900527388,\n \"y\": -27995837.265059903\n }\n },\n \"errorHandlers\": [\n {\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n },\n \"fallbackStepName\": \"\"\n },\n {\n \"retryStrategy\": {\n \"kind\": \"RETRY_STRATEGY_LINEAR\",\n \"linear\": {\n \"interval\": \"\",\n \"maxRetries\": 0\n }\n },\n \"fallbackStepName\": \"\"\n }\n ],\n \"outboundEdges\": [\n {\n \"nextStepName\": \"\",\n \"branchName\": \"\"\n },\n {\n \"nextStepName\": \"\",\n \"branchName\": \"\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": {\n \"description\": \"The `Parameter` `value`.\"\n }\n },\n {\n \"name\": \"\",\n \"value\": {\n \"description\": \"The `Parameter` `value`.\"\n }\n }\n ],\n \"readinessGate\": {\n \"thresholdType\": \"ANY\"\n }\n }\n ],\n \"triggers\": [\n {\n \"apiTrigger\": {\n \"rateLimit\": {\n \"count\": -11474465,\n \"interval\": \"reprehenderit\"\n }\n },\n \"startStepNames\": [\n \"\"\n ]\n },\n {\n \"apiTrigger\": {\n \"rateLimit\": {\n \"count\": -25102222,\n \"interval\": \"do dolore dolor\"\n }\n },\n \"startStepNames\": [\n \"\"\n ]\n }\n ]\n },\n \"tags\": [\n \"veniam elit\",\n \"proident eu sed\"\n ],\n \"updatedAt\": \"1995-02-28T06:14:49.944Z\",\n \"webhookSecret\": \"cupidatat aliqua tempor eu\"\n },\n \"id\": \"Excepteur esse\",\n \"relationships\": {\n \"creator\": {\n \"data\": {\n \"type\": \"users\",\n \"id\": \"\"\n }\n },\n \"owner\": {\n \"data\": {\n \"type\": \"users\",\n \"id\": \"\"\n }\n }\n }\n }\n}"
},
{
"name": "Bad request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"A sample workflow.\",\n \"name\": \"Example Workflow\",\n \"published\": true,\n \"spec\": {\n \"annotations\": [\n {\n \"display\": {\n \"bounds\": {\n \"height\": 150,\n \"width\": 300,\n \"x\": -375,\n \"y\": -0.5\n }\n },\n \"id\": \"99999999-9999-9999-9999-999999999999\",\n \"markdownTextAnnotation\": {\n \"text\": \"Example annotation.\"\n }\n }\n ],\n \"connectionEnvs\": [\n {\n \"connections\": [\n {\n \"connectionId\": \"11111111-1111-1111-1111-111111111111\",\n \"label\": \"INTEGRATION_DATADOG\"\n }\n ],\n \"env\": \"default\"\n }\n ],\n \"handle\": \"my-handle\",\n \"inputSchema\": {\n \"parameters\": [\n {\n \"defaultValue\": \"default\",\n \"name\": \"input\",\n \"type\": \"STRING\"\n }\n ]\n },\n \"outputSchema\": {\n \"parameters\": [\n {\n \"name\": \"output\",\n \"type\": \"ARRAY_OBJECT\",\n \"value\": \"{{ Steps.Step1 }}\"\n }\n ]\n },\n \"steps\": [\n {\n \"actionId\": \"com.datadoghq.dd.monitor.listMonitors\",\n \"connectionLabel\": \"INTEGRATION_DATADOG\",\n \"name\": \"Step1\",\n \"outboundEdges\": [\n {\n \"branchName\": \"main\",\n \"nextStepName\": \"Step2\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"tags\",\n \"value\": \"service:monitoring\"\n }\n ]\n },\n {\n \"actionId\": \"com.datadoghq.core.noop\",\n \"name\": \"Step2\"\n }\n ],\n \"triggers\": [\n {\n \"monitorTrigger\": {\n \"rateLimit\": {\n \"count\": 1,\n \"interval\": \"3600s\"\n }\n },\n \"startStepNames\": [\n \"Step1\"\n ]\n },\n {\n \"githubWebhookTrigger\": {},\n \"startStepNames\": [\n \"Step1\"\n ]\n }\n ]\n },\n \"tags\": [\n \"team:infra\",\n \"service:monitoring\",\n \"foo:bar\"\n ]\n },\n \"id\": \"22222222-2222-2222-2222-222222222222\",\n \"type\": \"workflows\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"anim0\": {},\n \"cillum_4c2\": {},\n \"consecteture3\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sed_690\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"A sample workflow.\",\n \"name\": \"Example Workflow\",\n \"published\": true,\n \"spec\": {\n \"annotations\": [\n {\n \"display\": {\n \"bounds\": {\n \"height\": 150,\n \"width\": 300,\n \"x\": -375,\n \"y\": -0.5\n }\n },\n \"id\": \"99999999-9999-9999-9999-999999999999\",\n \"markdownTextAnnotation\": {\n \"text\": \"Example annotation.\"\n }\n }\n ],\n \"connectionEnvs\": [\n {\n \"connections\": [\n {\n \"connectionId\": \"11111111-1111-1111-1111-111111111111\",\n \"label\": \"INTEGRATION_DATADOG\"\n }\n ],\n \"env\": \"default\"\n }\n ],\n \"handle\": \"my-handle\",\n \"inputSchema\": {\n \"parameters\": [\n {\n \"defaultValue\": \"default\",\n \"name\": \"input\",\n \"type\": \"STRING\"\n }\n ]\n },\n \"outputSchema\": {\n \"parameters\": [\n {\n \"name\": \"output\",\n \"type\": \"ARRAY_OBJECT\",\n \"value\": \"{{ Steps.Step1 }}\"\n }\n ]\n },\n \"steps\": [\n {\n \"actionId\": \"com.datadoghq.dd.monitor.listMonitors\",\n \"connectionLabel\": \"INTEGRATION_DATADOG\",\n \"name\": \"Step1\",\n \"outboundEdges\": [\n {\n \"branchName\": \"main\",\n \"nextStepName\": \"Step2\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"tags\",\n \"value\": \"service:monitoring\"\n }\n ]\n },\n {\n \"actionId\": \"com.datadoghq.core.noop\",\n \"name\": \"Step2\"\n }\n ],\n \"triggers\": [\n {\n \"monitorTrigger\": {\n \"rateLimit\": {\n \"count\": 1,\n \"interval\": \"3600s\"\n }\n },\n \"startStepNames\": [\n \"Step1\"\n ]\n },\n {\n \"githubWebhookTrigger\": {},\n \"startStepNames\": [\n \"Step1\"\n ]\n }\n ]\n },\n \"tags\": [\n \"team:infra\",\n \"service:monitoring\",\n \"foo:bar\"\n ]\n },\n \"id\": \"22222222-2222-2222-2222-222222222222\",\n \"type\": \"workflows\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"anim0\": {},\n \"cillum_4c2\": {},\n \"consecteture3\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sed_690\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"A sample workflow.\",\n \"name\": \"Example Workflow\",\n \"published\": true,\n \"spec\": {\n \"annotations\": [\n {\n \"display\": {\n \"bounds\": {\n \"height\": 150,\n \"width\": 300,\n \"x\": -375,\n \"y\": -0.5\n }\n },\n \"id\": \"99999999-9999-9999-9999-999999999999\",\n \"markdownTextAnnotation\": {\n \"text\": \"Example annotation.\"\n }\n }\n ],\n \"connectionEnvs\": [\n {\n \"connections\": [\n {\n \"connectionId\": \"11111111-1111-1111-1111-111111111111\",\n \"label\": \"INTEGRATION_DATADOG\"\n }\n ],\n \"env\": \"default\"\n }\n ],\n \"handle\": \"my-handle\",\n \"inputSchema\": {\n \"parameters\": [\n {\n \"defaultValue\": \"default\",\n \"name\": \"input\",\n \"type\": \"STRING\"\n }\n ]\n },\n \"outputSchema\": {\n \"parameters\": [\n {\n \"name\": \"output\",\n \"type\": \"ARRAY_OBJECT\",\n \"value\": \"{{ Steps.Step1 }}\"\n }\n ]\n },\n \"steps\": [\n {\n \"actionId\": \"com.datadoghq.dd.monitor.listMonitors\",\n \"connectionLabel\": \"INTEGRATION_DATADOG\",\n \"name\": \"Step1\",\n \"outboundEdges\": [\n {\n \"branchName\": \"main\",\n \"nextStepName\": \"Step2\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"tags\",\n \"value\": \"service:monitoring\"\n }\n ]\n },\n {\n \"actionId\": \"com.datadoghq.core.noop\",\n \"name\": \"Step2\"\n }\n ],\n \"triggers\": [\n {\n \"monitorTrigger\": {\n \"rateLimit\": {\n \"count\": 1,\n \"interval\": \"3600s\"\n }\n },\n \"startStepNames\": [\n \"Step1\"\n ]\n },\n {\n \"githubWebhookTrigger\": {},\n \"startStepNames\": [\n \"Step1\"\n ]\n }\n ]\n },\n \"tags\": [\n \"team:infra\",\n \"service:monitoring\",\n \"foo:bar\"\n ]\n },\n \"id\": \"22222222-2222-2222-2222-222222222222\",\n \"type\": \"workflows\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"anim0\": {},\n \"cillum_4c2\": {},\n \"consecteture3\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sed_690\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"A sample workflow.\",\n \"name\": \"Example Workflow\",\n \"published\": true,\n \"spec\": {\n \"annotations\": [\n {\n \"display\": {\n \"bounds\": {\n \"height\": 150,\n \"width\": 300,\n \"x\": -375,\n \"y\": -0.5\n }\n },\n \"id\": \"99999999-9999-9999-9999-999999999999\",\n \"markdownTextAnnotation\": {\n \"text\": \"Example annotation.\"\n }\n }\n ],\n \"connectionEnvs\": [\n {\n \"connections\": [\n {\n \"connectionId\": \"11111111-1111-1111-1111-111111111111\",\n \"label\": \"INTEGRATION_DATADOG\"\n }\n ],\n \"env\": \"default\"\n }\n ],\n \"handle\": \"my-handle\",\n \"inputSchema\": {\n \"parameters\": [\n {\n \"defaultValue\": \"default\",\n \"name\": \"input\",\n \"type\": \"STRING\"\n }\n ]\n },\n \"outputSchema\": {\n \"parameters\": [\n {\n \"name\": \"output\",\n \"type\": \"ARRAY_OBJECT\",\n \"value\": \"{{ Steps.Step1 }}\"\n }\n ]\n },\n \"steps\": [\n {\n \"actionId\": \"com.datadoghq.dd.monitor.listMonitors\",\n \"connectionLabel\": \"INTEGRATION_DATADOG\",\n \"name\": \"Step1\",\n \"outboundEdges\": [\n {\n \"branchName\": \"main\",\n \"nextStepName\": \"Step2\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"tags\",\n \"value\": \"service:monitoring\"\n }\n ]\n },\n {\n \"actionId\": \"com.datadoghq.core.noop\",\n \"name\": \"Step2\"\n }\n ],\n \"triggers\": [\n {\n \"monitorTrigger\": {\n \"rateLimit\": {\n \"count\": 1,\n \"interval\": \"3600s\"\n }\n },\n \"startStepNames\": [\n \"Step1\"\n ]\n },\n {\n \"githubWebhookTrigger\": {},\n \"startStepNames\": [\n \"Step1\"\n ]\n }\n ]\n },\n \"tags\": [\n \"team:infra\",\n \"service:monitoring\",\n \"foo:bar\"\n ]\n },\n \"id\": \"22222222-2222-2222-2222-222222222222\",\n \"type\": \"workflows\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"anim0\": {},\n \"cillum_4c2\": {},\n \"consecteture3\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sed_690\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
},
{
"name": "Delete an existing Workflow",
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id",
"value": "proident amet voluptate"
}
]
},
"description": "Delete a workflow by ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key)."
},
"response": [
{
"name": "Successfully deleted a workflow.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"anim0\": {},\n \"cillum_4c2\": {},\n \"consecteture3\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sed_690\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"anim0\": {},\n \"cillum_4c2\": {},\n \"consecteture3\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sed_690\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"anim0\": {},\n \"cillum_4c2\": {},\n \"consecteture3\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Missing required attribute in body\",\n \"meta\": {\n \"sed_690\": {}\n },\n \"source\": {\n \"header\": \"Authorization\",\n \"parameter\": \"limit\",\n \"pointer\": \"/data/attributes/title\"\n },\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}"
}
]
},
{
"name": "List workflow instances",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances?page[size]=10&page[number]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
}
],
"variable": [
{
"key": "workflow_id",
"value": "proident amet voluptate"
}
]
},
"description": "List all instances of a given workflow. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances?page[size]=10&page[number]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
}
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": \"aliqua mollit commodo Lorem\"\n },\n {\n \"id\": \"Ut\",\n \"sunt_82\": {}\n }\n ],\n \"meta\": {\n \"page\": {\n \"totalCount\": -71719632,\n \"aliqua6a7\": {}\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances?page[size]=10&page[number]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
}
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances?page[size]=10&page[number]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
}
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances?page[size]=10&page[number]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
}
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Execute a workflow",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"payload\": {\n \"officia30\": {}\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances"
],
"variable": [
{
"key": "workflow_id",
"value": "proident amet voluptate"
}
]
},
"description": "Execute the given workflow. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key)."
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"payload\": {\n \"officia30\": {}\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"labore nostrud Lorem pariatur\",\n \"estee2\": {}\n },\n \"irure_1c\": {},\n \"occaecat_3\": {},\n \"elit___\": {}\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"payload\": {\n \"officia30\": {}\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"payload\": {\n \"officia30\": {}\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"meta\": {\n \"payload\": {\n \"officia30\": {}\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances"
],
"variable": [
{
"key": "workflow_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Get a workflow instance",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances/:instance_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances",
":instance_id"
],
"variable": [
{
"key": "workflow_id",
"value": "proident amet voluptate"
},
{
"key": "instance_id",
"value": "proident amet voluptate"
}
]
},
"description": "Get a specific execution of a given workflow. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances/:instance_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances",
":instance_id"
],
"variable": [
{
"key": "workflow_id"
},
{
"key": "instance_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"attributes\": {\n \"id\": \"consectetur proident\",\n \"laboris0c\": {}\n },\n \"fugiat_08b\": {}\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances/:instance_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances",
":instance_id"
],
"variable": [
{
"key": "workflow_id"
},
{
"key": "instance_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances/:instance_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances",
":instance_id"
],
"variable": [
{
"key": "workflow_id"
},
{
"key": "instance_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances/:instance_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances",
":instance_id"
],
"variable": [
{
"key": "workflow_id"
},
{
"key": "instance_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances/:instance_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances",
":instance_id"
],
"variable": [
{
"key": "workflow_id"
},
{
"key": "instance_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
},
{
"name": "Cancel a workflow instance",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances/:instance_id/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances",
":instance_id",
"cancel"
],
"variable": [
{
"key": "workflow_id",
"value": "proident amet voluptate"
},
{
"key": "instance_id",
"value": "proident amet voluptate"
}
]
},
"description": "Cancels a specific execution of a given workflow. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key)."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances/:instance_id/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances",
":instance_id",
"cancel"
],
"variable": [
{
"key": "workflow_id"
},
{
"key": "instance_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": {\n \"id\": \"labore in\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances/:instance_id/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances",
":instance_id",
"cancel"
],
"variable": [
{
"key": "workflow_id"
},
{
"key": "instance_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances/:instance_id/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances",
":instance_id",
"cancel"
],
"variable": [
{
"key": "workflow_id"
},
{
"key": "instance_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances/:instance_id/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances",
":instance_id",
"cancel"
],
"variable": [
{
"key": "workflow_id"
},
{
"key": "instance_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "DD-API-KEY",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workflows/:workflow_id/instances/:instance_id/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workflows",
":workflow_id",
"instances",
":instance_id",
"cancel"
],
"variable": [
{
"key": "workflow_id"
},
{
"key": "instance_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n \"Bad Request\"\n ]\n}"
}
]
}
],
"description": "Datadog Workflow Automation allows you to automate your end-to-end processes by connecting Datadog with the rest of your tech stack. Build workflows to auto-remediate your alerts, streamline your incident and security processes, and reduce manual toil. Workflow Automation supports over 1,000+ OOTB actions, including AWS, JIRA, ServiceNow, GitHub, and OpenAI. Learn more in our Workflow Automation docs [here](https://docs.datadoghq.com/service_management/workflows/).",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
]
}
],
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"exec": [
"pm.request.headers.add({ key: 'DD-API-KEY', value: pm.collectionVariables.get('api_key') });",
"pm.request.headers.add({ key: 'DD-APPLICATION-KEY', value: pm.collectionVariables.get('application_key') });"
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
""
]
}
}
],
"variable": [
{
"key": "site",
"value": "datadoghq.com"
},
{
"key": "subdomain",
"value": "api"
},
{
"key": "baseUrl",
"value": "https://{{subdomain}}.{{site}}"
},
{
"key": "api_key",
"value": "",
"type": "string"
},
{
"key": "application_key",
"value": "",
"type": "string"
},
{
"key": "site",
"value": "datadoghq.eu",
"type": "string",
"disabled": true
},
{
"key": "site",
"value": "us3.datadoghq.com",
"type": "string",
"disabled": true
},
{
"key": "site",
"value": "us5.datadoghq.com",
"type": "string",
"disabled": true
},
{
"key": "site",
"value": "ap1.datadoghq.com",
"type": "string",
"disabled": true
},
{
"key": "site",
"value": "app.ddog-gov.com",
"type": "string",
"disabled": true
}
]
}