{ "opencollection": "1.0.0", "info": { "name": "Datadog Account Get API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "items": [ { "info": { "name": "Get", "type": "folder" }, "items": [ { "info": { "name": "Datadog Get an Existing Action Connection", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/actions/connections/:connection_id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "The ID of the action connection" } ] }, "docs": "Get an existing Action Connection" }, { "info": { "name": "Datadog Get Aws Scan Options", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/agentless_scanning/accounts/aws" }, "docs": "Fetches the scan options configured for AWS accounts." }, { "info": { "name": "Datadog Get Aws on Demand Tasks", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/agentless_scanning/ondemand/aws" }, "docs": "Fetches the most recent 1000 AWS on demand tasks." }, { "info": { "name": "Datadog Get Aws on Demand Task by Id", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/agentless_scanning/ondemand/aws/:task_id", "params": [ { "name": "task_id", "value": "6d09294c-9ad9-42fd-a759-a0c1599b4828", "type": "path", "description": "The UUID of the task." } ] }, "docs": "Fetch the data of a specific on demand task." }, { "info": { "name": "Datadog Get All Api Keys", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/api_keys", "params": [ { "name": "page[size]", "value": "", "type": "query", "description": "Size for a given page. The maximum allowed value is 100." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specific page number to return." }, { "name": "sort", "value": "", "type": "query", "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." }, { "name": "filter", "value": "", "type": "query", "description": "Filter API keys by the specified string." }, { "name": "filter[created_at][start]", "value": "", "type": "query", "description": "Only include API keys created on or after the specified date." }, { "name": "filter[created_at][end]", "value": "", "type": "query", "description": "Only include API keys created on or before the specified date." }, { "name": "filter[modified_at][start]", "value": "", "type": "query", "description": "Only include API keys modified on or after the specified date." }, { "name": "filter[modified_at][end]", "value": "", "type": "query", "description": "Only include API keys modified on or before the specified date." }, { "name": "include", "value": "", "type": "query", "description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`." }, { "name": "filter[remote_config_read_enabled]", "value": "", "type": "query", "description": "Filter API keys by remote config read enabled status." }, { "name": "filter[category]", "value": "", "type": "query", "description": "Filter API keys by category." } ] }, "docs": "List all API keys available for your account." }, { "info": { "name": "Datadog Get Api Key", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/api_keys/:api_key_id", "params": [ { "name": "api_key_id", "value": "", "type": "path", "description": "The ID of the API key." }, { "name": "include", "value": "", "type": "query", "description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`." } ] }, "docs": "Get an API key." }, { "info": { "name": "Datadog Get an Api", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/apicatalog/api/:id/openapi", "params": [ { "name": "id", "value": "abc-123-def", "type": "path", "description": "ID of the API to retrieve" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Retrieve information about a specific API in [OpenAPI](https://spec.openapis.org/oas/latest.html) format file." }, { "info": { "name": "Datadog Get All Span-based Metrics", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/apm/config/metrics" }, "docs": "Get the list of configured span-based metrics with their definitions." }, { "info": { "name": "Datadog Get a Span-based Metric", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/apm/config/metrics/:metric_id", "params": [ { "name": "metric_id", "value": "", "type": "path", "description": "The name of the span-based metric." } ] }, "docs": "Get a specific span-based metric from your organization." }, { "info": { "name": "Datadog Get a Given Apm Retention Filter", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/apm/config/retention-filters/:filter_id", "params": [ { "name": "filter_id", "value": "", "type": "path", "description": "The ID of the retention filter." } ] }, "docs": "Get an APM retention filter." }, { "info": { "name": "Datadog Get App", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/app-builder/apps/:app_id", "params": [ { "name": "app_id", "value": "65bb1f25-52e1-4510-9f8d-22d1516ed693", "type": "path", "description": "The ID of the app to retrieve." }, { "name": "version", "value": "example_value", "type": "query", "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." } ] }, "docs": "Get the full definition of an app." }, { "info": { "name": "Datadog Get All Application Keys", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/application_keys", "params": [ { "name": "page[size]", "value": "", "type": "query", "description": "Size for a given page. The maximum allowed value is 100." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specific page number to return." }, { "name": "sort", "value": "", "type": "query", "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." }, { "name": "filter", "value": "", "type": "query", "description": "Filter application keys by the specified string." }, { "name": "filter[created_at][start]", "value": "", "type": "query", "description": "Only include application keys created on or after the specified date." }, { "name": "filter[created_at][end]", "value": "", "type": "query", "description": "Only include application keys created on or before the specified date." }, { "name": "include", "value": "", "type": "query", "description": "Resource path for related resources to include in the response. Only `owned_by` is supported." } ] }, "docs": "List all application keys available for your org" }, { "info": { "name": "Datadog Get an Application Key", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/application_keys/:app_key_id", "params": [ { "name": "app_key_id", "value": "", "type": "path", "description": "The ID of the application key." }, { "name": "include", "value": "", "type": "query", "description": "Resource path for related resources to include in the response. Only `owned_by` is supported." } ] }, "docs": "Get an application key for your org." }, { "info": { "name": "Datadog Get a List of Audit Logs Events", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/audit/events", "params": [ { "name": "filter[query]", "value": "@type:session @application_id:xxxx", "type": "query", "description": "Search query following Audit Logs syntax." }, { "name": "filter[from]", "value": "2019-01-02T09:42:36.320Z", "type": "query", "description": "Minimum timestamp for requested events." }, { "name": "filter[to]", "value": "2019-01-03T09:42:36.320Z", "type": "query", "description": "Maximum timestamp for requested events." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of events in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of events in the response." } ] }, "docs": "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" }, { "info": { "name": "Datadog Get an Authn Mapping by Uuid", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/authn_mappings/:authn_mapping_id", "params": [ { "name": "authn_mapping_id", "value": "", "type": "path", "description": "The UUID of the AuthN Mapping." } ] }, "docs": "Get an AuthN Mapping specified by the AuthN Mapping UUID." }, { "info": { "name": "Datadog Get All Projects", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/cases/projects", "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all projects." }, { "info": { "name": "Datadog Get the Details of a Project", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/cases/projects/:project_id", "params": [ { "name": "project_id", "value": "e555e290-ed65-49bd-ae18-8acbfcf18db7", "type": "path", "description": "Project UUID" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get the details of a project by `project_id`." }, { "info": { "name": "Datadog Get the Details of a Case", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/cases/:case_id", "params": [ { "name": "case_id", "value": "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504", "type": "path", "description": "Case's UUID or key" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get the details of case by `case_id`" }, { "info": { "name": "Datadog Get a List of Entities", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/catalog/entity", "params": [ { "name": "page[offset]", "value": "", "type": "query", "description": "Specific offset to use as the beginning of the returned page." }, { "name": "page[limit]", "value": "100", "type": "query", "description": "Maximum number of entities in the response." }, { "name": "filter[id]", "value": "", "type": "query", "description": "Filter entities by UUID." }, { "name": "filter[ref]", "value": "service:shopping-cart", "type": "query", "description": "Filter entities by reference" }, { "name": "filter[name]", "value": "", "type": "query", "description": "Filter entities by name." }, { "name": "filter[kind]", "value": "", "type": "query", "description": "Filter entities by kind." }, { "name": "filter[owner]", "value": "", "type": "query", "description": "Filter entities by owner." }, { "name": "filter[relation][type]", "value": "", "type": "query", "description": "Filter entities by relation type." }, { "name": "filter[exclude_snapshot]", "value": "", "type": "query", "description": "Filter entities by excluding snapshotted entities." }, { "name": "include", "value": "", "type": "query", "description": "Include relationship data." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a list of entities from Software Catalog." }, { "info": { "name": "Datadog Get a List of Entity Relations", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/catalog/relation", "params": [ { "name": "page[offset]", "value": "", "type": "query", "description": "Specific offset to use as the beginning of the returned page." }, { "name": "page[limit]", "value": "100", "type": "query", "description": "Maximum number of relations in the response." }, { "name": "filter[type]", "value": "", "type": "query", "description": "Filter relations by type." }, { "name": "filter[from_ref]", "value": "service:shopping-cart", "type": "query", "description": "Filter relations by the reference of the first entity in the relation." }, { "name": "filter[to_ref]", "value": "service:shopping-cart", "type": "query", "description": "Filter relations by the reference of the second entity in the relation." }, { "name": "include", "value": "", "type": "query", "description": "Include relationship data." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a list of entity relations from Software Catalog." }, { "info": { "name": "Datadog Get a List of Pipelines Events", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/ci/pipelines/events", "params": [ { "name": "filter[query]", "value": "@ci.provider.name:github @ci.pipeline.name:Pull Request Labeler", "type": "query", "description": "Search query following log syntax." }, { "name": "filter[from]", "value": "2019-01-02T09:42:36.320Z", "type": "query", "description": "Minimum timestamp for requested events." }, { "name": "filter[to]", "value": "2019-01-03T09:42:36.320Z", "type": "query", "description": "Maximum timestamp for requested events." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of events in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of events in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Datadog Get a List of Tests Events", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/ci/tests/events", "params": [ { "name": "filter[query]", "value": "@test.name:test_foo @test.suite:github.com/DataDog/dd-go/model", "type": "query", "description": "Search query following log syntax." }, { "name": "filter[from]", "value": "2019-01-02T09:42:36.320Z", "type": "query", "description": "Minimum timestamp for requested events." }, { "name": "filter[to]", "value": "2019-01-03T09:42:36.320Z", "type": "query", "description": "Maximum timestamp for requested events." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of events in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of events in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Datadog Get a Custom Framework", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/cloud_security_management/custom_frameworks/:handle/:version", "params": [ { "name": "handle", "value": "", "type": "path", "description": "The framework handle" }, { "name": "version", "value": "", "type": "path", "description": "The framework version" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a custom framework." }, { "info": { "name": "Datadog Get All Container Images", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/container_images", "params": [ { "name": "filter[tags]", "value": "short_image:redis,status:running", "type": "query", "description": "Comma-separated list of tags to filter Container Images by." }, { "name": "group_by", "value": "registry,image_tags", "type": "query", "description": "Comma-separated list of tags to group Container Images by." }, { "name": "sort", "value": "container_count", "type": "query", "description": "Attribute to sort Container Images by." }, { "name": "page[size]", "value": "42", "type": "query", "description": "Maximum number of results returned." }, { "name": "page[cursor]", "value": "example_value", "type": "query", "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`." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all Container Images for your organization." }, { "info": { "name": "Datadog Get All Containers", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/containers", "params": [ { "name": "filter[tags]", "value": "env:prod,short_image:cassandra", "type": "query", "description": "Comma-separated list of tags to filter containers by." }, { "name": "group_by", "value": "datacenter,cluster", "type": "query", "description": "Comma-separated list of tags to group containers by." }, { "name": "sort", "value": "started_at", "type": "query", "description": "Attribute to sort containers by." }, { "name": "page[size]", "value": "42", "type": "query", "description": "Maximum number of results returned." }, { "name": "page[cursor]", "value": "example_value", "type": "query", "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`." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all containers for your organization." }, { "info": { "name": "Datadog Get a Budget", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/cost/budget/:budget_id", "params": [ { "name": "budget_id", "value": "", "type": "path", "description": "Budget id." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a budget." }, { "info": { "name": "Datadog Get Custom Costs File", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/cost/custom_costs/:file_id", "params": [ { "name": "file_id", "value": "", "type": "path", "description": "File ID." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Fetch the specified Custom Costs file." }, { "info": { "name": "Datadog Get Active Billing Dimensions for Cost Attribution", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/cost_by_tag/active_billing_dimensions", "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get active billing dimensions for cost attribution. Cost data for a given month becomes available no later than the 19th of the following month." }, { "info": { "name": "Datadog Get Monthly Cost Attribution", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/cost_by_tag/monthly_cost_attribution", "params": [ { "name": "start_month", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning in this month." }, { "name": "end_month", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month." }, { "name": "fields", "value": "example_value", "type": "query", "description": "Comma-separated list specifying cost types (e.g., `_on_demand_cost`, `_committed_cost`, `_total_cost`) and the\nproportions (`_percentage_in_org`, `_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`` 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)." }, { "name": "sort_direction", "value": "example_value", "type": "query", "description": "The direction to sort by: `[desc, asc]`." }, { "name": "sort_name", "value": "Example Monitor", "type": "query", "description": "The billing dimension to sort by. Always sorted by total cost. Example: `infra_host`." }, { "name": "tag_breakdown_keys", "value": "env:production", "type": "query", "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." }, { "name": "next_record_id", "value": "abc-123-def", "type": "query", "description": "List following results with a next_record_id provided in the previous query." }, { "name": "include_descendants", "value": "true", "type": "query", "description": "Include child org cost in the response. Defaults to `true`." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Datadog Get All Csm Agents", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/csm/onboarding/agents", "params": [ { "name": "page", "value": "2", "type": "query", "description": "The page index for pagination (zero-based)." }, { "name": "size", "value": "12", "type": "query", "description": "The number of items to include in a single page." }, { "name": "query", "value": "hostname:COMP-T2H4J27423", "type": "query", "description": "A search query string to filter results (for example, `hostname:COMP-T2H4J27423`)." }, { "name": "order_direction", "value": "example_value", "type": "query", "description": "The sort direction for results. Use `asc` for ascending or `desc` for descending." } ] }, "docs": "Get the list of all CSM Agents running on your hosts and containers." }, { "info": { "name": "Datadog Get the Csm Cloud Accounts Coverage Analysis", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/csm/onboarding/coverage_analysis/cloud_accounts" }, "docs": "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." }, { "info": { "name": "Datadog Get the Csm Hosts and Containers Coverage Analysis", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/csm/onboarding/coverage_analysis/hosts_and_containers" }, "docs": "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." }, { "info": { "name": "Datadog Get the Csm Serverless Coverage Analysis", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/csm/onboarding/coverage_analysis/serverless" }, "docs": "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." }, { "info": { "name": "Datadog Get All Csm Serverless Agents", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/csm/onboarding/serverless/agents", "params": [ { "name": "page", "value": "2", "type": "query", "description": "The page index for pagination (zero-based)." }, { "name": "size", "value": "12", "type": "query", "description": "The number of items to include in a single page." }, { "name": "query", "value": "hostname:COMP-T2H4J27423", "type": "query", "description": "A search query string to filter results (for example, `hostname:COMP-T2H4J27423`)." }, { "name": "order_direction", "value": "example_value", "type": "query", "description": "The sort direction for results. Use `asc` for ascending or `desc` for descending." } ] }, "docs": "Get the list of all CSM Serverless Agents running on your hosts and containers." }, { "info": { "name": "Datadog Get All Application Keys Owned by Current User", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/current_user/application_keys", "params": [ { "name": "page[size]", "value": "", "type": "query", "description": "Size for a given page. The maximum allowed value is 100." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specific page number to return." }, { "name": "sort", "value": "", "type": "query", "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." }, { "name": "filter", "value": "", "type": "query", "description": "Filter application keys by the specified string." }, { "name": "filter[created_at][start]", "value": "", "type": "query", "description": "Only include application keys created on or after the specified date." }, { "name": "filter[created_at][end]", "value": "", "type": "query", "description": "Only include application keys created on or before the specified date." }, { "name": "include", "value": "", "type": "query", "description": "Resource path for related resources to include in the response. Only `owned_by` is supported." } ] }, "docs": "List all application keys available for current user" }, { "info": { "name": "Datadog Get One Application Key Owned by Current User", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/current_user/application_keys/:app_key_id", "params": [ { "name": "app_key_id", "value": "", "type": "path", "description": "The ID of the application key." } ] }, "docs": "Get an application key owned by current user" }, { "info": { "name": "Datadog Get Items of a Dashboard List", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards", "params": [ { "name": "dashboard_list_id", "value": "42", "type": "path", "description": "ID of the dashboard list to get items from." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Fetch the dashboard list’s dashboard definitions." }, { "info": { "name": "Datadog Get Domain Allowlist", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/domain_allowlist", "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get the domain allowlist for an organization." }, { "info": { "name": "Datadog Get a List of Deployment Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/dora/deployments", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Use this API endpoint to get a list of deployment events." }, { "info": { "name": "Datadog Get a Deployment Event", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/dora/deployments/:deployment_id", "params": [ { "name": "deployment_id", "value": "abc-123-def", "type": "path", "description": "The ID of the deployment event." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Use this API endpoint to get a deployment event." }, { "info": { "name": "Datadog Get a List of Failure Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/dora/failures", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Use this API endpoint to get a list of failure events." }, { "info": { "name": "Datadog Get a Failure Event", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/dora/failures/:failure_id", "params": [ { "name": "failure_id", "value": "abc-123-def", "type": "path", "description": "The ID of the failure event." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Use this API endpoint to get a failure event." }, { "info": { "name": "Datadog Get All Downtimes", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/downtime", "params": [ { "name": "current_only", "value": "true", "type": "query", "description": "Only return downtimes that are active when the request is made." }, { "name": "include", "value": "created_by,monitor", "type": "query", "description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`." }, { "name": "page[offset]", "value": "", "type": "query", "description": "Specific offset to use as the beginning of the returned page." }, { "name": "page[limit]", "value": "100", "type": "query", "description": "Maximum number of downtimes in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all scheduled downtimes." }, { "info": { "name": "Datadog Get a Downtime", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/downtime/:downtime_id", "params": [ { "name": "downtime_id", "value": "00000000-0000-1234-0000-000000000000", "type": "path", "description": "ID of the downtime to fetch." }, { "name": "include", "value": "created_by,monitor", "type": "query", "description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get downtime detail by `downtime_id`." }, { "info": { "name": "Datadog Get a List of Events", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/events", "params": [ { "name": "filter[query]", "value": "avg:system.cpu.user{*}", "type": "query", "description": "Search query following events syntax." }, { "name": "filter[from]", "value": "example_value", "type": "query", "description": "Minimum timestamp for requested events, in milliseconds." }, { "name": "filter[to]", "value": "example_value", "type": "query", "description": "Maximum timestamp for requested events, in milliseconds." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of events in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of events in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Datadog Get a List of Incidents", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/incidents", "params": [ { "name": "include", "value": "", "type": "query", "description": "Specifies which types of related objects should be included in the response." }, { "name": "page[size]", "value": "", "type": "query", "description": "Size for a given page. The maximum allowed value is 100." }, { "name": "page[offset]", "value": "", "type": "query", "description": "Specific offset to use as the beginning of the returned page." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all incidents for the user's organization." }, { "info": { "name": "Datadog Get a List of Incident Types", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/incidents/config/types", "params": [ { "name": "include_deleted", "value": "", "type": "query", "description": "Include deleted incident types in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all incident types." }, { "info": { "name": "Datadog Get Incident Type Details", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/incidents/config/types/:incident_type_id", "params": [ { "name": "incident_type_id", "value": "", "type": "path", "description": "The UUID of the incident type." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get incident type details." }, { "info": { "name": "Datadog Get the Details of an Incident", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/incidents/:incident_id", "params": [ { "name": "incident_id", "value": "", "type": "path", "description": "The UUID of the incident." }, { "name": "include", "value": "", "type": "query", "description": "Specifies which types of related objects should be included in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get the details of an incident by `incident_id`." }, { "info": { "name": "Datadog Get a List of Attachments", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/incidents/:incident_id/attachments", "params": [ { "name": "incident_id", "value": "", "type": "path", "description": "The UUID of the incident." }, { "name": "include", "value": "", "type": "query", "description": "Specifies which types of related objects are included in the response." }, { "name": "filter[attachment_type]", "value": "", "type": "query", "description": "Specifies which types of attachments are included in the response." } ] }, "docs": "Get all attachments for a given incident." }, { "info": { "name": "Datadog Get a List of an Incident's Integration Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/incidents/:incident_id/relationships/integrations", "params": [ { "name": "incident_id", "value": "", "type": "path", "description": "The UUID of the incident." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all integration metadata for an incident." }, { "info": { "name": "Datadog Get Incident Integration Metadata Details", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/incidents/:incident_id/relationships/integrations/:integration_metadata_id", "params": [ { "name": "incident_id", "value": "", "type": "path", "description": "The UUID of the incident." }, { "name": "integration_metadata_id", "value": "", "type": "path", "description": "The UUID of the incident integration metadata." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get incident integration metadata details." }, { "info": { "name": "Datadog Get a List of an Incident's Todos", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/incidents/:incident_id/relationships/todos", "params": [ { "name": "incident_id", "value": "", "type": "path", "description": "The UUID of the incident." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all todos for an incident." }, { "info": { "name": "Datadog Get Incident Todo Details", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/incidents/:incident_id/relationships/todos/:todo_id", "params": [ { "name": "incident_id", "value": "", "type": "path", "description": "The UUID of the incident." }, { "name": "todo_id", "value": "", "type": "path", "description": "The UUID of the incident todo." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get incident todo details." }, { "info": { "name": "Datadog Get an Aws Integration by Config Id", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integration/aws/accounts/:aws_account_config_id", "params": [ { "name": "aws_account_config_id", "value": "", "type": "path", "description": "Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the\n[List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) endpoint and query by AWS Account ID." } ] }, "docs": "Get an AWS Account Integration Config by config ID." }, { "info": { "name": "Datadog Get List of Aws Log Ready Services", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integration/aws/logs/services" }, "docs": "Get a list of AWS services that can send logs to Datadog." }, { "info": { "name": "Datadog Get Channel Information by Name", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integration/ms-teams/configuration/channel/:tenant_name/:team_name/:channel_name", "params": [ { "name": "tenant_name", "value": "", "type": "path", "description": "Your tenant name." }, { "name": "team_name", "value": "", "type": "path", "description": "Your team name." }, { "name": "channel_name", "value": "", "type": "path", "description": "Your channel name." } ] }, "docs": "Get the tenant, team, and channel ID of a channel in the Datadog Microsoft Teams integration." }, { "info": { "name": "Datadog Get All Tenant-based Handles", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integration/ms-teams/configuration/tenant-based-handles", "params": [ { "name": "tenant_id", "value": "", "type": "query", "description": "Your tenant id." }, { "name": "name", "value": "", "type": "query", "description": "Your tenant-based handle name." } ] }, "docs": "Get a list of all tenant-based handles from the Datadog Microsoft Teams integration." }, { "info": { "name": "Datadog Get Tenant-based Handle Information", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integration/ms-teams/configuration/tenant-based-handles/:handle_id", "params": [ { "name": "handle_id", "value": "", "type": "path", "description": "Your tenant-based handle id." } ] }, "docs": "Get the tenant, team, and channel information of a tenant-based handle from the Datadog Microsoft Teams integration." }, { "info": { "name": "Datadog Get All Workflows Webhook Handles", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles", "params": [ { "name": "name", "value": "", "type": "query", "description": "Your Workflows webhook handle name." } ] }, "docs": "Get a list of all Workflows webhook handles from the Datadog Microsoft Teams integration." }, { "info": { "name": "Datadog Get Workflows Webhook Handle Information", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles/:handle_id", "params": [ { "name": "handle_id", "value": "", "type": "path", "description": "Your Workflows webhook handle id." } ] }, "docs": "Get the name of a Workflows webhook handle from the Datadog Microsoft Teams integration." }, { "info": { "name": "Datadog Get All Service Objects", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integration/opsgenie/services" }, "docs": "Get a list of all services from the Datadog Opsgenie integration." }, { "info": { "name": "Datadog Get a Single Service Object", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integration/opsgenie/services/:integration_service_id", "params": [ { "name": "integration_service_id", "value": "", "type": "path", "description": "The UUID of the service." } ] }, "docs": "Get a single service from the Datadog Opsgenie integration." }, { "info": { "name": "Datadog Get Cloudflare Account", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integrations/cloudflare/accounts/:account_id", "params": [ { "name": "account_id", "value": "abc-123-def", "type": "path", "description": "None" } ] }, "docs": "Get a Cloudflare account." }, { "info": { "name": "Datadog Get Confluent Account", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integrations/confluent-cloud/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Confluent Account ID." } ] }, "docs": "Get the Confluent account with the provided account ID." }, { "info": { "name": "Datadog Get Resource from Confluent Account", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources/:resource_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Confluent Account ID." }, { "name": "resource_id", "value": "", "type": "path", "description": "Confluent Account Resource ID." } ] }, "docs": "Get a Confluent resource with the provided resource id for the account associated with the provided account ID." }, { "info": { "name": "Datadog Get Fastly Account", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integrations/fastly/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Fastly Account id." } ] }, "docs": "Get a Fastly account." }, { "info": { "name": "Datadog Get Fastly Service", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integrations/fastly/accounts/:account_id/services/:service_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Fastly Account id." }, { "name": "service_id", "value": "", "type": "path", "description": "Fastly Service ID." } ] }, "docs": "Get a Fastly service for an account." }, { "info": { "name": "Datadog Get Okta Account", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integrations/okta/accounts/:account_id", "params": [ { "name": "account_id", "value": "abc-123-def", "type": "path", "description": "None" } ] }, "docs": "Get an Okta account." }, { "info": { "name": "Datadog Get Ip Allowlist", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/ip_allowlist", "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Returns the IP allowlist and its enabled or disabled state." }, { "info": { "name": "Datadog Get Archive Order", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/logs/config/archive-order" }, "docs": "Get the current order of your archives.\nThis endpoint takes no JSON arguments." }, { "info": { "name": "Datadog Get All Archives", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/logs/config/archives" }, "docs": "Get the list of configured logs archives with their definitions." }, { "info": { "name": "Datadog Get an Archive", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/logs/config/archives/:archive_id", "params": [ { "name": "archive_id", "value": "", "type": "path", "description": "The ID of the archive." } ] }, "docs": "Get a specific archive from your organization." }, { "info": { "name": "Datadog Get All Custom Destinations", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/logs/config/custom-destinations" }, "docs": "Get the list of configured custom destinations in your organization with their definitions." }, { "info": { "name": "Datadog Get a Custom Destination", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/logs/config/custom-destinations/:custom_destination_id", "params": [ { "name": "custom_destination_id", "value": "", "type": "path", "description": "The ID of the custom destination." } ] }, "docs": "Get a specific custom destination in your organization." }, { "info": { "name": "Datadog Get All Log-based Metrics", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/logs/config/metrics" }, "docs": "Get the list of configured log-based metrics with their definitions." }, { "info": { "name": "Datadog Get a Log-based Metric", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/logs/config/metrics/:metric_id", "params": [ { "name": "metric_id", "value": "", "type": "path", "description": "The name of the log-based metric." } ] }, "docs": "Get a specific log-based metric from your organization." }, { "info": { "name": "Datadog Get Restriction Query for a Given Role", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/logs/config/restriction_queries/role/:role_id", "params": [ { "name": "role_id", "value": "", "type": "path", "description": "The ID of the role." } ] }, "docs": "Get restriction query for a given role." }, { "info": { "name": "Datadog Get All Restriction Queries for a Given User", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/logs/config/restriction_queries/user/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "The ID of the user." } ] }, "docs": "Get all restriction queries for a given user." }, { "info": { "name": "Datadog Get a Restriction Query", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/logs/config/restriction_queries/:restriction_query_id", "params": [ { "name": "restriction_query_id", "value": "", "type": "path", "description": "The ID of the restriction query." } ] }, "docs": "Get a restriction query in the organization specified by the restriction query's `restriction_query_id`." }, { "info": { "name": "Datadog Search Logs (get)", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/logs/events", "params": [ { "name": "filter[query]", "value": "@datacenter:us @role:db", "type": "query", "description": "Search query following logs syntax." }, { "name": "filter[indexes]", "value": "main,web", "type": "query", "description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes" }, { "name": "filter[from]", "value": "2019-01-02T09:42:36.320Z", "type": "query", "description": "Minimum timestamp for requested logs." }, { "name": "filter[to]", "value": "2019-01-03T09:42:36.320Z", "type": "query", "description": "Maximum timestamp for requested logs." }, { "name": "filter[storage_tier]", "value": "indexes", "type": "query", "description": "Specifies the storage type to be used" }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of logs in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of logs in the response." } ] }, "docs": "List endpoint returns logs that match a log search query.\n[Results are paginated][1].\n\nUse this endpoint to search and filter your 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" }, { "info": { "name": "Datadog Get a List of Metrics", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/metrics", "params": [ { "name": "filter[configured]", "value": "true", "type": "query", "description": "Filter custom metrics that have configured tags." }, { "name": "filter[tags_configured]", "value": "app", "type": "query", "description": "Filter tag configurations by configured tags." }, { "name": "filter[metric_type]", "value": "metric alert", "type": "query", "description": "Filter metrics by metric type." }, { "name": "filter[include_percentiles]", "value": "true", "type": "query", "description": "Filter distributions with additional percentile\naggregations enabled or disabled." }, { "name": "filter[queried]", "value": "true", "type": "query", "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." }, { "name": "filter[tags]", "value": "env IN (staging,test) AND service:web", "type": "query", "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." }, { "name": "filter[related_assets]", "value": "true", "type": "query", "description": "(Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs." }, { "name": "window[seconds]", "value": "3600", "type": "query", "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)." }, { "name": "page[size]", "value": "42", "type": "query", "description": "Maximum number of results returned." }, { "name": "page[cursor]", "value": "example_value", "type": "query", "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." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "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_cur" }, { "info": { "name": "Datadog Get All Monitor Notification Rules", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/monitor/notification_rule", "params": [ { "name": "include", "value": "created_by", "type": "query", "description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npath is `created_by`." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Returns a list of all monitor notification rules." }, { "info": { "name": "Datadog Get a Monitor Notification Rule", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/monitor/notification_rule/:rule_id", "params": [ { "name": "rule_id", "value": "abc-123-def", "type": "path", "description": "ID of the monitor notification rule to fetch." }, { "name": "include", "value": "created_by", "type": "query", "description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npath is `created_by`." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Returns a monitor notification rule by `rule_id`." }, { "info": { "name": "Datadog Get All Monitor Configuration Policies", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/monitor/policy", "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all monitor configuration policies." }, { "info": { "name": "Datadog Get a Monitor Configuration Policy", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/monitor/policy/:policy_id", "params": [ { "name": "policy_id", "value": "00000000-0000-1234-0000-000000000000", "type": "path", "description": "ID of the monitor configuration policy." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a monitor configuration policy by `policy_id`." }, { "info": { "name": "Datadog Get Active Downtimes for a Monitor", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/monitor/:monitor_id/downtime_matches", "params": [ { "name": "monitor_id", "value": "42", "type": "path", "description": "The id of the monitor." }, { "name": "page[offset]", "value": "", "type": "query", "description": "Specific offset to use as the beginning of the returned page." }, { "name": "page[limit]", "value": "100", "type": "query", "description": "Maximum number of downtimes in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all active downtimes for the specified monitor." }, { "info": { "name": "Datadog Get the List of Devices", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/ndm/devices", "params": [ { "name": "page[size]", "value": "", "type": "query", "description": "Size for a given page. The maximum allowed value is 100." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specific page number to return." }, { "name": "sort", "value": "status", "type": "query", "description": "The field to sort the devices by." }, { "name": "filter[tag]", "value": "status:ok", "type": "query", "description": "Filter devices by tag." } ] }, "docs": "Get the list of devices." }, { "info": { "name": "Datadog Get the Device Details", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/ndm/devices/:device_id", "params": [ { "name": "device_id", "value": "example:1.2.3.4", "type": "path", "description": "The id of the device to fetch." } ] }, "docs": "Get the device details." }, { "info": { "name": "Datadog Get the List of Interfaces of the Device", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/ndm/interfaces", "params": [ { "name": "device_id", "value": "example:1.2.3.4", "type": "query", "description": "The ID of the device to get interfaces from." }, { "name": "get_ip_addresses", "value": "true", "type": "query", "description": "Whether to get the IP addresses of the interfaces." } ] }, "docs": "Get the list of interfaces of the device." }, { "info": { "name": "Datadog Get the List of Tags for a Device", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/ndm/tags/devices/:device_id", "params": [ { "name": "device_id", "value": "example:1.2.3.4", "type": "path", "description": "The id of the device to fetch tags for." } ] }, "docs": "Get the list of tags for a device." }, { "info": { "name": "Datadog Get All Aggregated Connections", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/network/connections/aggregate", "params": [ { "name": "from", "value": "42", "type": "query", "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]`." }, { "name": "to", "value": "42", "type": "query", "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]`." }, { "name": "group_by", "value": "example_value", "type": "query", "description": "Comma-separated list of fields to group connections by." }, { "name": "tags", "value": "env:production", "type": "query", "description": "Comma-separated list of tags to filter connections by." }, { "name": "limit", "value": "42", "type": "query", "description": "The number of connections to be returned. The maximum value is 5000." } ] }, "docs": "Get all aggregated connections." }, { "info": { "name": "Datadog Get On-call Escalation Policy", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/on-call/escalation-policies/:policy_id", "params": [ { "name": "policy_id", "value": "a3000000-0000-0000-0000-000000000000", "type": "path", "description": "The ID of the escalation policy" }, { "name": "include", "value": "example_value", "type": "query", "description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get an On-Call escalation policy" }, { "info": { "name": "Datadog Get On-call Schedule", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/on-call/schedules/:schedule_id", "params": [ { "name": "include", "value": "example_value", "type": "query", "description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`." }, { "name": "schedule_id", "value": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", "type": "path", "description": "The ID of the schedule" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get an On-Call schedule" }, { "info": { "name": "Datadog Get the Schedule On-call User", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/on-call/schedules/:schedule_id/on-call", "params": [ { "name": "include", "value": "example_value", "type": "query", "description": "Specifies related resources to include in the response as a comma-separated list. Allowed value: `user`." }, { "name": "schedule_id", "value": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", "type": "path", "description": "The ID of the schedule." }, { "name": "filter[at_ts]", "value": "2025-05-07T02:53:01Z", "type": "query", "description": "Retrieves the on-call user at the given timestamp (ISO-8601). Defaults to the current time if omitted.\"" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Retrieves the user who is on-call for the specified schedule at a given time." }, { "info": { "name": "Datadog Get Team On-call Users", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/on-call/teams/:team_id/on-call", "params": [ { "name": "include", "value": "example_value", "type": "query", "description": "Comma-separated list of included relationships to be returned. Allowed values: `responders`, `escalations`, `escalations.responders`." }, { "name": "team_id", "value": "27590dae-47be-4a7d-9abf-8f4e45124020", "type": "path", "description": "The team ID" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a team's on-call users at a given time" }, { "info": { "name": "Datadog Get On-call Team Routing Rules", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/on-call/teams/:team_id/routing-rules", "params": [ { "name": "team_id", "value": "27590dae-47be-4a7d-9abf-8f4e45124020", "type": "path", "description": "The team ID" }, { "name": "include", "value": "example_value", "type": "query", "description": "Comma-separated list of included relationships to be returned. Allowed values: `rules`, `rules.policy`." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a team's On-Call routing rules" }, { "info": { "name": "Datadog Get a Specific Org Config Value", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/org_configs/:org_config_name", "params": [ { "name": "org_config_name", "value": "", "type": "path", "description": "The name of an Org Config." } ] }, "docs": "Return the name, description, and value of a specific Org Config." }, { "info": { "name": "Datadog Get a Finding", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/posture_management/findings/:finding_id", "params": [ { "name": "finding_id", "value": "abc-123-def", "type": "path", "description": "The ID of the finding." }, { "name": "snapshot_timestamp", "value": "1678721573794", "type": "query", "description": "Return the finding for a given snapshot of time (Unix ms)." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Returns a single finding with message and resource configuration." }, { "info": { "name": "Datadog Get All Powerpacks", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/powerpacks", "params": [ { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of powerpacks in the response." }, { "name": "page[offset]", "value": "", "type": "query", "description": "Specific offset to use as the beginning of the returned page." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a list of all powerpacks." }, { "info": { "name": "Datadog Get a Powerpack", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/powerpacks/:powerpack_id", "params": [ { "name": "powerpack_id", "value": "abc-123-def", "type": "path", "description": "ID of the powerpack." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a powerpack." }, { "info": { "name": "Datadog Get All Processes", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/processes", "params": [ { "name": "search", "value": "example_value", "type": "query", "description": "String to search processes by." }, { "name": "tags", "value": "account:prod,user:admin", "type": "query", "description": "Comma-separated list of tags to filter processes by." }, { "name": "from", "value": "42", "type": "query", "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]`." }, { "name": "to", "value": "42", "type": "query", "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]`." }, { "name": "page[limit]", "value": "42", "type": "query", "description": "Maximum number of results returned." }, { "name": "page[cursor]", "value": "example_value", "type": "query", "description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all processes for your organization." }, { "info": { "name": "Datadog Get a Waf Custom Rule", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/asm/waf/custom_rules/:custom_rule_id", "params": [ { "name": "custom_rule_id", "value": "3b5-v82-ns6", "type": "path", "description": "The ID of the custom rule." } ] }, "docs": "Retrieve a WAF custom rule by ID." }, { "info": { "name": "Datadog Get a Waf Exclusion Filter", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/asm/waf/exclusion_filters/:exclusion_filter_id", "params": [ { "name": "exclusion_filter_id", "value": "3b5-v82-ns6", "type": "path", "description": "The identifier of the WAF exclusion filter." } ] }, "docs": "Retrieve a specific WAF exclusion filter using its identifier." }, { "info": { "name": "Datadog Get All Workload Protection Agent Rules", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/cws/agent_rules", "params": [ { "name": "policy_id", "value": "6517fcc1-cec7-4394-a655-8d6e9d085255", "type": "query", "description": "The ID of the Agent policy" } ] }, "docs": "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." }, { "info": { "name": "Datadog Get a Workload Protection Agent Rule", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/cws/agent_rules/:agent_rule_id", "params": [ { "name": "agent_rule_id", "value": "3b5-v82-ns6", "type": "path", "description": "The ID of the Agent rule" }, { "name": "policy_id", "value": "6517fcc1-cec7-4394-a655-8d6e9d085255", "type": "query", "description": "The ID of the Agent policy" } ] }, "docs": "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." }, { "info": { "name": "Datadog Get All Workload Protection Policies", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/cws/policy" }, "docs": "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." }, { "info": { "name": "Datadog Get a Workload Protection Policy", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/cws/policy/:policy_id", "params": [ { "name": "policy_id", "value": "6517fcc1-cec7-4394-a655-8d6e9d085255", "type": "path", "description": "The ID of the Agent policy" } ] }, "docs": "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." }, { "info": { "name": "Datadog Get a Specific Pipeline", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/obs_pipelines/pipelines/:pipeline_id", "params": [ { "name": "pipeline_id", "value": "abc-123-def", "type": "path", "description": "The ID of the pipeline to retrieve." } ] }, "docs": "Get a specific pipeline by its ID." }, { "info": { "name": "Datadog Get a Restriction Policy", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/restriction_policy/:resource_id", "params": [ { "name": "resource_id", "value": "dashboard:abc-def-ghi", "type": "path", "description": "Identifier, formatted as `type:id`. Supported types: `connection`, `dashboard`, `integration-account`, `integration-service`, `integration-webhook`, `notebook`, `reference-table`, `security-rule`, `slo`, `workflow`, `app-builder-app`, `connection`, `connection-group`, `rum-application`." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Retrieves the restriction policy associated with a specified resource." }, { "info": { "name": "Datadog Get a Role", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/roles/:role_id", "params": [ { "name": "role_id", "value": "", "type": "path", "description": "The unique identifier of the role." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a role in the organization specified by the role’s `role_id`." }, { "info": { "name": "Datadog Get All Users of a Role", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/roles/:role_id/users", "params": [ { "name": "role_id", "value": "", "type": "path", "description": "The unique identifier of the role." }, { "name": "page[size]", "value": "", "type": "query", "description": "Size for a given page. The maximum allowed value is 100." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specific page number to return." }, { "name": "sort", "value": "example_value", "type": "query", "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`." }, { "name": "filter", "value": "example_value", "type": "query", "description": "Filter all users by the given string. Defaults to no filtering." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Gets all users of a role." }, { "info": { "name": "Datadog Get All Rum Retention Filters", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/rum/applications/:app_id/retention_filters", "params": [ { "name": "app_id", "value": "", "type": "path", "description": "RUM application ID." } ] }, "docs": "Get the list of RUM retention filters for a RUM application." }, { "info": { "name": "Datadog Get a Rum Retention Filter", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/rum/applications/:app_id/retention_filters/:rf_id", "params": [ { "name": "app_id", "value": "", "type": "path", "description": "RUM application ID." }, { "name": "rf_id", "value": "", "type": "path", "description": "Retention filter ID." } ] }, "docs": "Get a RUM retention filter for a RUM application." }, { "info": { "name": "Datadog Get a Rum Application", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/rum/applications/:id", "params": [ { "name": "id", "value": "abc-123-def", "type": "path", "description": "RUM application ID." } ] }, "docs": "Get the RUM application with given ID in your organization." }, { "info": { "name": "Datadog Get All Rum-based Metrics", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/rum/config/metrics" }, "docs": "Get the list of configured rum-based metrics with their definitions." }, { "info": { "name": "Datadog Get a Rum-based Metric", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/rum/config/metrics/:metric_id", "params": [ { "name": "metric_id", "value": "", "type": "path", "description": "The name of the rum-based metric." } ] }, "docs": "Get a specific rum-based metric from your organization." }, { "info": { "name": "Datadog Get a List of Rum Events", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/rum/events", "params": [ { "name": "filter[query]", "value": "@type:session @application_id:xxxx", "type": "query", "description": "Search query following RUM syntax." }, { "name": "filter[from]", "value": "2019-01-02T09:42:36.320Z", "type": "query", "description": "Minimum timestamp for requested events." }, { "name": "filter[to]", "value": "2019-01-03T09:42:36.320Z", "type": "query", "description": "Maximum timestamp for requested events." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of events in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of events in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "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" }, { "info": { "name": "Datadog Get Group", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/scim/Groups/:group_id", "params": [ { "name": "group_id", "value": "abc-123-def", "type": "path", "description": "None" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a single group using the `group_id`." }, { "info": { "name": "Datadog Get User", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/scim/Users/:user_uuid", "params": [ { "name": "user_uuid", "value": "abc-123-def", "type": "path", "description": "None" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a single user using the `user_uuid`." }, { "info": { "name": "Datadog Get Sbom", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security/sboms/:asset_type", "params": [ { "name": "asset_type", "value": "Repository", "type": "path", "description": "The type of the asset for the SBOM request." }, { "name": "filter[asset_name]", "value": "github.com/datadog/datadog-agent", "type": "query", "description": "The name of the asset for the SBOM request." }, { "name": "filter[repo_digest]", "value": "sha256:0ae7da091191787229d321e3638e39c319a97d6e20f927d465b519d699215bf7", "type": "query", "description": "The container image `repo_digest` for the SBOM request. When the requested asset type is 'Image', this filter is mandatory." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a single SBOM related to an asset by its type and name.\n" }, { "info": { "name": "Datadog Get the List of Signal-based Notification Rules", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security/signals/notification_rules", "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Returns the list of notification rules for security signals." }, { "info": { "name": "Datadog Get Details of a Signal-based Notification Rule", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security/signals/notification_rules/:id", "params": [ { "name": "id", "value": "abc-123-def", "type": "path", "description": "ID of the notification rule." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get the details of a notification rule for security signals." }, { "info": { "name": "Datadog Get the List of Vulnerability Notification Rules", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security/vulnerabilities/notification_rules", "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Returns the list of notification rules for security vulnerabilities." }, { "info": { "name": "Datadog Get Details of a Vulnerability Notification Rule", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security/vulnerabilities/notification_rules/:id", "params": [ { "name": "id", "value": "abc-123-def", "type": "path", "description": "ID of the notification rule." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get the details of a notification rule for security vulnerabilities." }, { "info": { "name": "Datadog Get All Workload Protection Agent Rules (us1-fed)", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/cloud_workload_security/agent_rules" }, "docs": "Get the list of agent rules.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site." }, { "info": { "name": "Datadog Get a Workload Protection Agent Rule (us1-fed)", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id", "params": [ { "name": "agent_rule_id", "value": "3b5-v82-ns6", "type": "path", "description": "The ID of the Agent rule" } ] }, "docs": "Get the details of a specific agent rule.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site." }, { "info": { "name": "Datadog Get All Security Filters", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/configuration/security_filters", "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get the list of configured security filters with their definitions." }, { "info": { "name": "Datadog Get a Security Filter", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id", "params": [ { "name": "security_filter_id", "value": "", "type": "path", "description": "The ID of the security filter." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Datadog Get All Suppression Rules", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/configuration/suppressions", "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get the list of all suppression rules." }, { "info": { "name": "Datadog Get a Suppression Rule", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/configuration/suppressions/:suppression_id", "params": [ { "name": "suppression_id", "value": "", "type": "path", "description": "The ID of the suppression rule" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get the details of a specific suppression rule." }, { "info": { "name": "Datadog Get a Rule's Details", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path", "description": "The ID of the rule." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a rule's details." }, { "info": { "name": "Datadog Get a Rule's Version History", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/rules/:rule_id/version_history", "params": [ { "name": "rule_id", "value": "", "type": "path", "description": "The ID of the rule." }, { "name": "page[size]", "value": "", "type": "query", "description": "Size for a given page. The maximum allowed value is 100." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specific page number to return." } ] }, "docs": "Get a rule's version history." }, { "info": { "name": "Datadog Get a Quick List of Security Signals", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/signals", "params": [ { "name": "filter[query]", "value": "security:attack status:high", "type": "query", "description": "The search query for security signals." }, { "name": "filter[from]", "value": "2019-01-02T09:42:36.320Z", "type": "query", "description": "The minimum timestamp for requested security signals." }, { "name": "filter[to]", "value": "2019-01-03T09:42:36.320Z", "type": "query", "description": "The maximum timestamp for requested security signals." }, { "name": "sort", "value": "example_value", "type": "query", "description": "The order of the security signals in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "A list of results using the cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "The maximum number of security signals in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Datadog Get a List of Security Signals", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/signals/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Returns security signals that match a search query.\nBoth this endpoint and the GET endpoint can be used interchangeably for listing\nsecurity signals." }, { "info": { "name": "Datadog Get a Signal's Details", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/signals/:signal_id", "params": [ { "name": "signal_id", "value": "", "type": "path", "description": "The ID of the signal." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a signal's details." }, { "info": { "name": "Datadog Get One Application Key for This Service Account", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "The ID of the service account." }, { "name": "app_key_id", "value": "", "type": "path", "description": "The ID of the application key." } ] }, "docs": "Get an application key owned by this service account." }, { "info": { "name": "Datadog Get a List of All Incident Services", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/services", "params": [ { "name": "include", "value": "", "type": "query", "description": "Specifies which types of related objects should be included in the response." }, { "name": "page[size]", "value": "", "type": "query", "description": "Size for a given page. The maximum allowed value is 100." }, { "name": "page[offset]", "value": "", "type": "query", "description": "Specific offset to use as the beginning of the returned page." }, { "name": "filter", "value": "", "type": "query", "description": "A search query that filters services by name." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all incident services uploaded for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident services." }, { "info": { "name": "Datadog Get All Service Definitions", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/services/definitions", "params": [ { "name": "page[size]", "value": "", "type": "query", "description": "Size for a given page. The maximum allowed value is 100." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specific page number to return." }, { "name": "schema_version", "value": "", "type": "query", "description": "The schema version desired in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a list of all service definitions from the Datadog Service Catalog." }, { "info": { "name": "Datadog Get a Single Service Definition", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/services/definitions/:service_name", "params": [ { "name": "service_name", "value": "", "type": "path", "description": "The name of the service." }, { "name": "schema_version", "value": "", "type": "query", "description": "The schema version desired in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a single service definition from the Datadog Service Catalog." }, { "info": { "name": "Datadog Get Details of an Incident Service", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/services/:service_id", "params": [ { "name": "service_id", "value": "", "type": "path", "description": "The ID of the incident service." }, { "name": "include", "value": "", "type": "query", "description": "Specifies which types of related objects should be included in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get details of an incident service. If the `include[users]` query parameter is provided,\nthe included attribute will contain the users related to these incident services." }, { "info": { "name": "Datadog Get a Job's Details", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/siem-historical-detections/jobs/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path", "description": "The ID of the job." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a job's details." }, { "info": { "name": "Datadog Get Slo Report", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/slo/report/:report_id/download", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "The ID of the report job." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Download an SLO report. This can only be performed after the report job has completed.\n\nReports are not guaranteed to exist indefinitely. Datadog recommends that you download the report as soon as it is available." }, { "info": { "name": "Datadog Get Slo Report Status", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/slo/report/:report_id/status", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "The ID of the report job." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get the status of the SLO report job." }, { "info": { "name": "Datadog Get a List of Spans", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/spans/events", "params": [ { "name": "filter[query]", "value": "@datacenter:us @role:db", "type": "query", "description": "Search query following spans syntax." }, { "name": "filter[from]", "value": "2023-01-02T09:42:36.320Z", "type": "query", "description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)." }, { "name": "filter[to]", "value": "2023-01-03T09:42:36.320Z", "type": "query", "description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of spans in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of spans in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "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" }, { "info": { "name": "Datadog Get the On-demand Concurrency Cap", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/synthetics/settings/on_demand_concurrency_cap" }, "docs": "Get the on-demand concurrency cap." }, { "info": { "name": "Datadog Get All Teams", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/team", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "Specific page number to return." }, { "name": "page[size]", "value": "", "type": "query", "description": "Size for a given page. The maximum allowed value is 100." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Specifies the order of the returned teams" }, { "name": "include", "value": "", "type": "query", "description": "Included related resources optionally requested. Allowed enum values: `team_links, user_team_permissions`" }, { "name": "filter[keyword]", "value": "example_value", "type": "query", "description": "Search query. Can be team name, team handle, or email of team member" }, { "name": "filter[me]", "value": "true", "type": "query", "description": "When true, only returns teams the current user belongs to" }, { "name": "fields[team]", "value": "", "type": "query", "description": "List of fields that need to be fetched." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all teams.\nCan be used to search for teams using the `filter[keyword]` and `filter[me]` query parameters." }, { "info": { "name": "Datadog Get a Team", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/team/:team_id", "params": [ { "name": "team_id", "value": "abc-123-def", "type": "path", "description": "None" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a single team using the team's `id`." }, { "info": { "name": "Datadog Get Links for a Team", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/team/:team_id/links", "params": [ { "name": "team_id", "value": "abc-123-def", "type": "path", "description": "None" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all links for a given team." }, { "info": { "name": "Datadog Get a Team Link", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/team/:team_id/links/:link_id", "params": [ { "name": "team_id", "value": "abc-123-def", "type": "path", "description": "None" }, { "name": "link_id", "value": "abc-123-def", "type": "path", "description": "None" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a single link for a team." }, { "info": { "name": "Datadog Get Team Memberships", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/team/:team_id/memberships", "params": [ { "name": "team_id", "value": "abc-123-def", "type": "path", "description": "None" }, { "name": "page[size]", "value": "", "type": "query", "description": "Size for a given page. The maximum allowed value is 100." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specific page number to return." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Specifies the order of returned team memberships" }, { "name": "filter[keyword]", "value": "example_value", "type": "query", "description": "Search query, can be user email or name" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a paginated list of members for a team" }, { "info": { "name": "Datadog Get Permission Settings for a Team", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/team/:team_id/permission-settings", "params": [ { "name": "team_id", "value": "abc-123-def", "type": "path", "description": "None" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all permission settings for a given team." }, { "info": { "name": "Datadog Get a List of All Incident Teams", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/teams", "params": [ { "name": "include", "value": "", "type": "query", "description": "Specifies which types of related objects should be included in the response." }, { "name": "page[size]", "value": "", "type": "query", "description": "Size for a given page. The maximum allowed value is 100." }, { "name": "page[offset]", "value": "", "type": "query", "description": "Specific offset to use as the beginning of the returned page." }, { "name": "filter", "value": "", "type": "query", "description": "A search query that filters teams by name." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all incident teams for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident teams." }, { "info": { "name": "Datadog Get Details of an Incident Team", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/teams/:team_id", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The ID of the incident team." }, { "name": "include", "value": "", "type": "query", "description": "Specifies which types of related objects should be included in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get details of an incident team. If the `include[users]` query parameter is provided,\nthe included attribute will contain the users related to these incident teams." }, { "info": { "name": "Datadog Get Hourly Usage for Application Security", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/usage/application_security", "params": [ { "name": "start_hr", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." }, { "name": "end_hr", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get hourly usage for application security .\n**Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)" }, { "info": { "name": "Datadog Get Billing Dimension Mapping for Usage Endpoints", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/usage/billing_dimension_mapping", "params": [ { "name": "filter[month]", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, and for mappings beginning this month. Defaults to the current month." }, { "name": "filter[view]", "value": "example_value", "type": "query", "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`." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "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/)." }, { "info": { "name": "Datadog Get Cost Across Multi-org Account", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/usage/cost_by_org", "params": [ { "name": "start_month", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month." }, { "name": "end_month", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get cost across multi-org account.\nCost by org data for a given month becomes available no later than the 16th of the following month.\n**Note:** This endpoint has been deprecated. Please use the new endpoint\n[`/historical_cost`](https://docs.datadoghq.com/api/latest/usage-metering/#get-historical-cost-across-your-account)\ninstead.\n\nThis endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/)." }, { "info": { "name": "Datadog Get Estimated Cost Across Your Account", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/usage/estimated_cost", "params": [ { "name": "view", "value": "example_value", "type": "query", "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`." }, { "name": "start_month", "value": "example_value", "type": "query", "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." }, { "name": "end_month", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month." }, { "name": "start_date", "value": "2026-04-17T12:00:00Z", "type": "query", "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." }, { "name": "end_date", "value": "2026-04-17T12:00:00Z", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` for cost ending this day." }, { "name": "include_connected_accounts", "value": "true", "type": "query", "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`. " } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "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/)." }, { "info": { "name": "Datadog Get Historical Cost Across Your Account", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/usage/historical_cost", "params": [ { "name": "view", "value": "example_value", "type": "query", "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`." }, { "name": "start_month", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month." }, { "name": "end_month", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month." }, { "name": "include_connected_accounts", "value": "true", "type": "query", "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`. " } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "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/)." }, { "info": { "name": "Datadog Get Hourly Usage by Product Family", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/usage/hourly_usage", "params": [ { "name": "filter[timestamp][start]", "value": "2026-04-17T12:00:00Z", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." }, { "name": "filter[timestamp][end]", "value": "2026-04-17T12:00:00Z", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." }, { "name": "filter[product_families]", "value": "example_value", "type": "query", "description": "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`, `logs`, `network_flows`, `network_hosts`, `network_monitoring`, `observability_pipelines`,\n`online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`, `sds`, `snmp`, `software_delivery`,\n`synthetics_api`, `synthetics_browser`, `synthetics_mobile`, `synthetics_parallel_testing`, `timeseries`, `vuln_management`,\nand `workflow_executions`.\nThe following product family has been **deprecated**: `audit_logs`." }, { "name": "filter[include_descendants]", "value": "true", "type": "query", "description": "Include child org usage in the response. Defaults to false." }, { "name": "filter[include_connected_accounts]", "value": "true", "type": "query", "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." }, { "name": "filter[include_breakdown]", "value": "true", "type": "query", "description": "Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false." }, { "name": "filter[versions]", "value": "example_value", "type": "query", "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`." }, { "name": "page[limit]", "value": "42", "type": "query", "description": "Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified." }, { "name": "page[next_record_id]", "value": "abc-123-def", "type": "query", "description": "List following results with a next_record_id provided in the previous query." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get hourly usage by product family." }, { "info": { "name": "Datadog Get Hourly Usage for Lambda Traced Invocations", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/usage/lambda_traced_invocations", "params": [ { "name": "start_hr", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." }, { "name": "end_hr", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get hourly usage for Lambda traced invocations.\n**Note:** This endpoint has been deprecated.. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)" }, { "info": { "name": "Datadog Get Hourly Usage for Observability Pipelines", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/usage/observability_pipelines", "params": [ { "name": "start_hr", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." }, { "name": "end_hr", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get hourly usage for observability pipelines.\n**Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)" }, { "info": { "name": "Datadog Get Projected Cost Across Your Account", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/usage/projected_cost", "params": [ { "name": "view", "value": "example_value", "type": "query", "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`." }, { "name": "include_connected_accounts", "value": "true", "type": "query", "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`. " } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "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/)." }, { "info": { "name": "Datadog Get a User Invitation", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/user_invitations/:user_invitation_uuid", "params": [ { "name": "user_invitation_uuid", "value": "00000000-0000-0000-3456-000000000000", "type": "path", "description": "The UUID of the user invitation." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Returns a single user invitation by its UUID." }, { "info": { "name": "Datadog Get User Details", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/users/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "The ID of the user." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a user in the organization specified by the user’s `user_id`." }, { "info": { "name": "Datadog Get a User Organization", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/users/:user_id/orgs", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "The ID of the user." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a user organization. Returns the user information and all organizations\njoined by this user." }, { "info": { "name": "Datadog Get a User Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/users/:user_id/permissions", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "The ID of the user." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a user permission set. Returns a list of the user’s permissions\ngranted by the associated user's roles." }, { "info": { "name": "Datadog Get User Memberships", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/users/:user_uuid/memberships", "params": [ { "name": "user_uuid", "value": "abc-123-def", "type": "path", "description": "None" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a list of memberships for a user" }, { "info": { "name": "Datadog Get an Existing Workflow", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/workflows/:workflow_id", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The ID of the workflow." } ] }, "docs": "Get a workflow by ID. This API requires an application key scoped with the `workflows_read` permission." }, { "info": { "name": "Datadog Get a Workflow Instance", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/workflows/:workflow_id/instances/:instance_id", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The ID of the workflow." }, { "name": "instance_id", "value": "", "type": "path", "description": "The ID of the workflow instance." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a specific execution of a given workflow. This API requires an application key scoped with the workflows_read permission." } ] } ], "bundled": true }