{ "opencollection": "1.0.0", "info": { "name": "Datadog API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "items": [ { "info": { "name": "Action", "type": "folder" }, "items": [ { "info": { "name": "Datadog Create a New Action Connection", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/actions/connections", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Action Connection" }, { "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 Update an Existing Action Connection", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/actions/connections/:connection_id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "The ID of the action connection" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Action Connection" }, { "info": { "name": "Datadog Delete an Existing Action Connection", "type": "http" }, "http": { "method": "DELETE", "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": "Delete an existing Action Connection" } ] }, { "info": { "name": "Get", "type": "folder" }, "items": [ { "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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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." } ] }, { "info": { "name": "Options", "type": "folder" }, "items": [ { "info": { "name": "Datadog Post Aws Scan Options", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/agentless_scanning/accounts/aws", "body": { "type": "json", "data": "{}" } }, "docs": "Activate Agentless scan options for an AWS account." }, { "info": { "name": "Datadog Patch Aws Scan Options", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/agentless_scanning/accounts/aws/:account_id", "params": [ { "name": "account_id", "value": "123456789012", "type": "path", "description": "The ID of an AWS account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Agentless scan options for an activated account." } ] }, { "info": { "name": "Delete", "type": "folder" }, "items": [ { "info": { "name": "Datadog Delete Aws Scan Options", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/agentless_scanning/accounts/aws/:account_id", "params": [ { "name": "account_id", "value": "123456789012", "type": "path", "description": "The ID of an AWS account." } ] }, "docs": "Delete Agentless scan options for an AWS account." }, { "info": { "name": "Datadog Delete an Api Key", "type": "http" }, "http": { "method": "DELETE", "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." } ] }, "docs": "Delete an API key." }, { "info": { "name": "Datadog Delete an Api", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/apicatalog/api/:id", "params": [ { "name": "id", "value": "abc-123-def", "type": "path", "description": "ID of the API to delete" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Delete a specific API by ID." }, { "info": { "name": "Datadog Delete a Span-based Metric", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a specific span-based metric from your organization." }, { "info": { "name": "Datadog Delete a Retention Filter", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a specific retention filter from your organization.\n\nDefault filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be deleted." }, { "info": { "name": "Datadog Delete an Authn Mapping", "type": "http" }, "http": { "method": "DELETE", "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": "Delete an AuthN Mapping specified by AuthN Mapping UUID." }, { "info": { "name": "Datadog Delete a Single Entity", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/catalog/entity/:entity_id", "params": [ { "name": "entity_id", "value": "", "type": "path", "description": "UUID or Entity Ref." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Delete a single entity in Software Catalog." }, { "info": { "name": "Datadog Delete an Incident Type", "type": "http" }, "http": { "method": "DELETE", "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": "Delete an incident type." }, { "info": { "name": "Datadog Delete an Existing Incident", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/incidents/:incident_id", "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": "Deletes an existing incident from the users organization." }, { "info": { "name": "Datadog Delete an Incident Integration Metadata", "type": "http" }, "http": { "method": "DELETE", "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": "Delete an incident integration metadata." }, { "info": { "name": "Datadog Delete an Incident Todo", "type": "http" }, "http": { "method": "DELETE", "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": "Delete an incident todo." }, { "info": { "name": "Datadog Delete an Aws Integration", "type": "http" }, "http": { "method": "DELETE", "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": "Delete an AWS Account Integration Config by config ID." }, { "info": { "name": "Datadog Delete Tenant-based Handle", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a tenant-based handle from the Datadog Microsoft Teams integration." }, { "info": { "name": "Datadog Delete Workflows Webhook Handle", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a Workflows webhook handle from the Datadog Microsoft Teams integration." }, { "info": { "name": "Datadog Delete a Single Service Object", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a single service object in the Datadog Opsgenie integration." }, { "info": { "name": "Datadog Delete Fastly Service", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a Fastly service for an account." }, { "info": { "name": "Datadog Delete a Log-based Metric", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a specific log-based metric from your organization." }, { "info": { "name": "Datadog Delete a Restriction Query", "type": "http" }, "http": { "method": "DELETE", "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": "Deletes a restriction query." }, { "info": { "name": "Datadog Delete Tags for Multiple Metrics", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/metrics/config/bulk-tags", "body": { "type": "json", "data": "{}" } }, "docs": "Delete all custom lists of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.\nMetrics are selected by passing a metric name prefix.\nResults can be sent to a set of account email addresses, just like the same operation in the Datadog web app.\nCan only be used with application keys of users with the `Manage Tags for Metrics` permission." }, { "info": { "name": "Datadog Delete a Monitor Notification Rule", "type": "http" }, "http": { "method": "DELETE", "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 delete." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Deletes a monitor notification rule by `rule_id`." }, { "info": { "name": "Datadog Delete On-call Escalation Policy", "type": "http" }, "http": { "method": "DELETE", "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" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Delete an On-Call escalation policy" }, { "info": { "name": "Datadog Delete On-call Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/on-call/schedules/:schedule_id", "params": [ { "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": "Delete an On-Call schedule" }, { "info": { "name": "Datadog Delete a Powerpack", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/powerpacks/:powerpack_id", "params": [ { "name": "powerpack_id", "value": "abc-123-def", "type": "path", "description": "Powerpack id" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Delete a powerpack." }, { "info": { "name": "Datadog Delete a Waf Exclusion Filter", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a specific WAF exclusion filter using its identifier." }, { "info": { "name": "Datadog Delete a Workload Protection Policy", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a specific Workload Protection policy.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below." }, { "info": { "name": "Datadog Delete a Pipeline", "type": "http" }, "http": { "method": "DELETE", "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 delete." } ] }, "docs": "Delete a pipeline." }, { "info": { "name": "Datadog Delete a Restriction Policy", "type": "http" }, "http": { "method": "DELETE", "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": "Deletes the restriction policy associated with a specified resource." }, { "info": { "name": "Datadog Delete Role", "type": "http" }, "http": { "method": "DELETE", "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": "Disables a role." }, { "info": { "name": "Datadog Delete a Rum Retention Filter", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a RUM retention filter for a RUM application." }, { "info": { "name": "Datadog Delete a Rum-based Metric", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a specific rum-based metric from your organization." }, { "info": { "name": "Datadog Delete Group", "type": "http" }, "http": { "method": "DELETE", "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": "Delete the group with the given `group_id`." }, { "info": { "name": "Datadog Delete User", "type": "http" }, "http": { "method": "DELETE", "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": "Delete the group with the given `user_uuid`." }, { "info": { "name": "Datadog Delete a Rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/scorecard/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": "Deletes a single rule." }, { "info": { "name": "Datadog Delete a Signal-based Notification Rule", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a notification rule for security signals." }, { "info": { "name": "Datadog Delete a Vulnerability-based Notification Rule", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a notification rule for security vulnerabilities." }, { "info": { "name": "Datadog Delete a Security Filter", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a specific security filter." }, { "info": { "name": "Datadog Delete a Suppression Rule", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a specific suppression rule." }, { "info": { "name": "Datadog Delete an Existing Rule", "type": "http" }, "http": { "method": "DELETE", "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": "Delete an existing rule. Default rules cannot be deleted." }, { "info": { "name": "Datadog Delete Scanning Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/sensitive-data-scanner/config/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "The ID of a group of rules." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a given group." }, { "info": { "name": "Datadog Delete Scanning Rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/sensitive-data-scanner/config/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path", "description": "The ID of the rule." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a given rule." }, { "info": { "name": "Datadog Delete an Existing Incident Service", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/services/:service_id", "params": [ { "name": "service_id", "value": "", "type": "path", "description": "The ID of the incident service." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Deletes an existing incident service." }, { "info": { "name": "Datadog Delete an Existing Job", "type": "http" }, "http": { "method": "DELETE", "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": "Delete an existing job." }, { "info": { "name": "Datadog Delete an Existing Incident Team", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/teams/:team_id", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The ID of the incident team." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Deletes an existing incident team." }, { "info": { "name": "Datadog Delete an Existing Workflow", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/workflows/:workflow_id", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The ID of the workflow." } ] }, "docs": "Delete a workflow by ID. This API requires an application key scoped with the `workflows_write` permission." } ] }, { "info": { "name": "Demand", "type": "folder" }, "items": [ { "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 Post an Aws on Demand Task", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/agentless_scanning/ondemand/aws", "body": { "type": "json", "data": "{}" } }, "docs": "Trigger the scan of an AWS resource with a high priority. Agentless scanning must be activated for the AWS account containing the resource to scan." }, { "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": "All", "type": "folder" }, "items": [ { "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 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 List All Apm Retention Filters", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/apm/config/retention-filters" }, "docs": "Get the list of APM retention filters." }, { "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 List All Authn Mappings", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/authn_mappings", "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": "example_value", "type": "query", "description": "Sort AuthN Mappings depending on the given field." }, { "name": "filter", "value": "example_value", "type": "query", "description": "Filter all mappings by the given string." }, { "name": "resource_type", "value": "metric alert", "type": "query", "description": "Filter by mapping resource type. Defaults to \"role\" if not specified." } ] }, "docs": "List all AuthN Mappings in the org." }, { "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 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 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 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 List All Aws Integrations", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integration/aws/accounts", "params": [ { "name": "aws_account_id", "value": "123456789012", "type": "query", "description": "Optional query parameter to filter accounts by AWS Account ID. If not provided, all accounts are returned." } ] }, "docs": "Get a list of AWS Account Integration Configs." }, { "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 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 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 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 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 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 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 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 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 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 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 List All Waf Custom Rules", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/asm/waf/custom_rules" }, "docs": "Retrieve a list of WAF custom rule." }, { "info": { "name": "Datadog List All Waf Exclusion Filters", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/asm/waf/exclusion_filters" }, "docs": "Retrieve a list of WAF exclusion filters." }, { "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 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 List All the Rum Applications", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/rum/applications" }, "docs": "List all the RUM applications in your organization." }, { "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 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 List All Rule Outcomes", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/scorecard/outcomes", "params": [ { "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": "include", "value": "rule", "type": "query", "description": "Include related rule details in the response." }, { "name": "fields[outcome]", "value": "state, service_name", "type": "query", "description": "Return only specified values in the outcome attributes." }, { "name": "fields[rule]", "value": "name", "type": "query", "description": "Return only specified values in the included rule details." }, { "name": "filter[outcome][service_name]", "value": "web-store", "type": "query", "description": "Filter the outcomes on a specific service name." }, { "name": "filter[outcome][state]", "value": "fail", "type": "query", "description": "Filter the outcomes by a specific state." }, { "name": "filter[rule][enabled]", "value": "true", "type": "query", "description": "Filter outcomes on whether a rule is enabled/disabled." }, { "name": "filter[rule][id]", "value": "f4485c79-0762-449c-96cf-c31e54a659f6", "type": "query", "description": "Filter outcomes based on rule ID." }, { "name": "filter[rule][name]", "value": "SLOs Defined", "type": "query", "description": "Filter outcomes based on rule name." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Fetches all rule outcomes." }, { "info": { "name": "Datadog List All Rules", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/scorecard/rules", "params": [ { "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": "include", "value": "scorecard", "type": "query", "description": "Include related scorecard details in the response." }, { "name": "filter[rule][id]", "value": "37d2f990-c885-4972-949b-8b798213a166", "type": "query", "description": "Filter the rules on a rule ID." }, { "name": "filter[rule][enabled]", "value": "true", "type": "query", "description": "Filter for enabled rules only." }, { "name": "filter[rule][custom]", "value": "true", "type": "query", "description": "Filter for custom rules only." }, { "name": "filter[rule][name]", "value": "Code Repos Defined", "type": "query", "description": "Filter rules on the rule name." }, { "name": "filter[rule][description]", "value": "Identifying", "type": "query", "description": "Filter rules on the rule description." }, { "name": "fields[rule]", "value": "name, description", "type": "query", "description": "Return only specific fields in the response for rule attributes." }, { "name": "fields[scorecard]", "value": "name", "type": "query", "description": "Return only specific fields in the included response for scorecard attributes." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Fetch all rules." }, { "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 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 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 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 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 List All Users", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/users", "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": "name", "type": "query", "description": "User attribute to order results by. Sort order is ascending by default.\nSort order is descending if the field\nis prefixed by a negative sign, for example `sort=-name`. Options: `name`,\n`modified_at`, `user_count`." }, { "name": "sort_dir", "value": "example_value", "type": "query", "description": "Direction of sort. Options: `asc`, `desc`." }, { "name": "filter", "value": "example_value", "type": "query", "description": "Filter all users by the given string. Defaults to no filtering." }, { "name": "filter[status]", "value": "Active", "type": "query", "description": "Filter on status attribute.\nComma separated list, with possible values `Active`, `Pending`, and `Disabled`.\nDefaults to no filtering." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get the list of all users in the organization. This list includes\nall users even if they are deactivated or unverified." } ] }, { "info": { "name": "Create", "type": "folder" }, "items": [ { "info": { "name": "Datadog Create an Api Key", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/api_keys", "body": { "type": "json", "data": "{}" } }, "docs": "Create an API key." }, { "info": { "name": "Datadog Create a New Api", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/apicatalog/openapi", "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a new API from the [OpenAPI](https://spec.openapis.org/oas/latest.html) specification given.\nSee the [API Catalog documentation](https://docs.datadoghq.com/api_catalog/add_metadata/) for additional\ninformation about the possible metadata.\nIt returns the created API ID.\n" }, { "info": { "name": "Datadog Create a Span-based Metric", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/apm/config/metrics", "body": { "type": "json", "data": "{}" } }, "docs": "Create a metric based on your ingested spans in your organization.\nReturns the span-based metric object from the request body when the request is successful." }, { "info": { "name": "Datadog Create a Retention Filter", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/apm/config/retention-filters", "body": { "type": "json", "data": "{}" } }, "docs": "Create a retention filter to index spans in your organization.\nReturns the retention filter definition when the request is successful.\n\nDefault filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be created." }, { "info": { "name": "Datadog Create an Authn Mapping", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/authn_mappings", "body": { "type": "json", "data": "{}" } }, "docs": "Create an AuthN Mapping." }, { "info": { "name": "Datadog Create a Project", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/cases/projects", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a project." }, { "info": { "name": "Datadog Create or Update Entities", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/catalog/entity", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create or update entities in Software Catalog." }, { "info": { "name": "Datadog Create a Custom Framework", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/cloud_security_management/custom_frameworks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a custom framework." }, { "info": { "name": "Datadog Create an Incident", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/incidents", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create an incident." }, { "info": { "name": "Datadog Create an Incident Type", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/incidents/config/types", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create an incident type." }, { "info": { "name": "Datadog Create an Incident Integration Metadata", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/incidents/:incident_id/relationships/integrations", "params": [ { "name": "incident_id", "value": "", "type": "path", "description": "The UUID of the incident." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create an incident integration metadata." }, { "info": { "name": "Datadog Create an Incident Todo", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/incidents/:incident_id/relationships/todos", "params": [ { "name": "incident_id", "value": "", "type": "path", "description": "The UUID of the incident." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create an incident todo." }, { "info": { "name": "Datadog Create an Aws Integration", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/integration/aws/accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new AWS Account Integration Config." }, { "info": { "name": "Datadog Create a Datadog Gcp Principal", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/integration/gcp/sts_delegate", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Datadog GCP principal." }, { "info": { "name": "Datadog Create Tenant-based Handle", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/integration/ms-teams/configuration/tenant-based-handles", "body": { "type": "json", "data": "{}" } }, "docs": "Create a tenant-based handle in the Datadog Microsoft Teams integration." }, { "info": { "name": "Datadog Create Workflows Webhook Handle", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/integration/ms-teams/configuration/workflows-webhook-handles", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Workflows webhook handle in the Datadog Microsoft Teams integration." }, { "info": { "name": "Datadog Create a New Service Object", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/integration/opsgenie/services", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new service object in the Opsgenie integration." }, { "info": { "name": "Datadog Create a Custom Destination", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/logs/config/custom-destinations", "body": { "type": "json", "data": "{}" } }, "docs": "Create a custom destination in your organization." }, { "info": { "name": "Datadog Create a Log-based Metric", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/logs/config/metrics", "body": { "type": "json", "data": "{}" } }, "docs": "Create a metric based on your ingested logs in your organization.\nReturns the log-based metric object from the request body when the request is successful." }, { "info": { "name": "Datadog Create a Restriction Query", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/logs/config/restriction_queries", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new restriction query for your organization." }, { "info": { "name": "Datadog Create a Monitor Notification Rule", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/monitor/notification_rule", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Creates a monitor notification rule." }, { "info": { "name": "Datadog Create On-call Escalation Policy", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/on-call/escalation-policies", "params": [ { "name": "include", "value": "example_value", "type": "query", "description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a new On-Call escalation policy" }, { "info": { "name": "Datadog Create On-call Page", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/on-call/pages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Trigger a new On-Call Page.\n" }, { "info": { "name": "Datadog Create On-call Schedule", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/on-call/schedules", "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`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a new On-Call schedule" }, { "info": { "name": "Datadog Create a New Powerpack", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/powerpacks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a powerpack." }, { "info": { "name": "Datadog Create a Waf Custom Rule", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/asm/waf/custom_rules", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new WAF custom rule with the given parameters." }, { "info": { "name": "Datadog Create a Waf Exclusion Filter", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/asm/waf/exclusion_filters", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new WAF exclusion filter with the given parameters.\n\nA request matched by an exclusion filter will be ignored by the Application Security WAF product.\nGo to https://app.datadoghq.com/security/appsec/passlist to review existing exclusion filters (also called passlist entries)." }, { "info": { "name": "Datadog Create a Workload Protection Policy", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/cws/policy", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Workload Protection policy with the given parameters.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below." }, { "info": { "name": "Datadog Create a New Pipeline", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/obs_pipelines/pipelines", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new pipeline." }, { "info": { "name": "Datadog Create Role", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/roles", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a new role for your organization." }, { "info": { "name": "Datadog Create a New Role by Cloning an Existing Role", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/roles/:role_id/clone", "params": [ { "name": "role_id", "value": "", "type": "path", "description": "The unique identifier of the role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Clone an existing role" }, { "info": { "name": "Datadog Create a Rum Retention Filter", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/rum/applications/:app_id/retention_filters", "params": [ { "name": "app_id", "value": "", "type": "path", "description": "RUM application ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a RUM retention filter for a RUM application.\nReturns RUM retention filter objects from the request body when the request is successful." }, { "info": { "name": "Datadog Create a Rum-based Metric", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/rum/config/metrics", "body": { "type": "json", "data": "{}" } }, "docs": "Create a metric based on your organization's RUM data.\nReturns the rum-based metric object from the request body when the request is successful." }, { "info": { "name": "Datadog Create Group", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/scim/Groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new group.\nThe group may contain members." }, { "info": { "name": "Datadog Create User", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/scim/Users", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new user." }, { "info": { "name": "Datadog Create a New Rule", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/scorecard/rules", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Creates a new rule." }, { "info": { "name": "Datadog Create a New Signal-based Notification Rule", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/security/signals/notification_rules", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a new notification rule for security signals and return the created rule." }, { "info": { "name": "Datadog Create a New Vulnerability-based Notification Rule", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/security/vulnerabilities/notification_rules", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a new notification rule for security vulnerabilities and return the created rule." }, { "info": { "name": "Datadog Create a Security Filter", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/configuration/security_filters", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a security filter.\n\nSee the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)\nfor more examples." }, { "info": { "name": "Datadog Create a Suppression Rule", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/configuration/suppressions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a new suppression rule." }, { "info": { "name": "Datadog Create a Detection Rule", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/rules", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a detection rule." }, { "info": { "name": "Datadog Create Scanning Group", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/sensitive-data-scanner/config/groups", "body": { "type": "json", "data": "{}" } }, "docs": "Create a scanning group.\nThe request MAY include a configuration relationship.\nA rules relationship can be omitted entirely, but if it is included it MUST be\nnull or an empty array (rules cannot be created at the same time).\nThe new group will be ordered last within the configuration." }, { "info": { "name": "Datadog Create Scanning Rule", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/sensitive-data-scanner/config/rules", "body": { "type": "json", "data": "{}" } }, "docs": "Create a scanning rule in a sensitive data scanner group, ordered last.\nThe posted rule MUST include a group relationship.\nIt MUST include either a standard_pattern relationship or a regex attribute, but not both.\nIf included_attributes is empty or missing, we will scan all attributes except\nexcluded_attributes. If both are missing, we will scan the whole event." }, { "info": { "name": "Datadog Create a New Incident Service", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/services", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Creates a new incident service." }, { "info": { "name": "Datadog Create or Update Service Definition", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/services/definitions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create or update service definition in the Datadog Service Catalog." }, { "info": { "name": "Datadog Create a New Slo Report", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/slo/report", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a job to generate an SLO report. The report job is processed asynchronously and eventually results in a CSV report being available for download.\n\nCheck the status of the job and download the CSV report using the returned `report_id`." }, { "info": { "name": "Datadog Create a Team", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/team", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a new team.\nUser IDs passed through the `users` relationship field are added to the team." }, { "info": { "name": "Datadog Create a Team Link", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/team/:team_id/links", "params": [ { "name": "team_id", "value": "abc-123-def", "type": "path", "description": "None" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Add a new link to a team." }, { "info": { "name": "Datadog Create a New Incident Team", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/teams", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Creates a new incident team." }, { "info": { "name": "Datadog Create a User", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/users", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a user for your organization." }, { "info": { "name": "Datadog Create a Workflow", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/workflows", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new workflow, returning the workflow ID. This API requires an application key scoped with the `workflows_write` permission." } ] }, { "info": { "name": "Edit", "type": "folder" }, "items": [ { "info": { "name": "Datadog Edit an Api Key", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an API key." }, { "info": { "name": "Datadog Edit an Authn Mapping", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit an AuthN Mapping." } ] }, { "info": { "name": "Lists", "type": "folder" }, "items": [ { "info": { "name": "Datadog List Apis", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/apicatalog/api", "params": [ { "name": "query", "value": "payments", "type": "query", "description": "Filter APIs by name" }, { "name": "page[limit]", "value": "42", "type": "query", "description": "Number of items per page." }, { "name": "page[offset]", "value": "42", "type": "query", "description": "Offset for pagination." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List APIs and their IDs." }, { "info": { "name": "Datadog List Resource Filters", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/cloud_security_management/resource_filters", "params": [ { "name": "cloud_provider", "value": "", "type": "query", "description": "Filter resource filters by cloud provider (e.g. aws, gcp, azure)." }, { "name": "account_id", "value": "", "type": "query", "description": "Filter resource filters by cloud provider account ID. This parameter is only valid when provider is specified." }, { "name": "skip_cache", "value": "", "type": "query", "description": "Skip cache for resource filters." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List resource filters." }, { "info": { "name": "Datadog List Fastly Services", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integrations/fastly/accounts/:account_id/services", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Fastly Account id." } ] }, "docs": "List Fastly services for an account." }, { "info": { "name": "Datadog List Restriction Queries", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/logs/config/restriction_queries", "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." } ] }, "docs": "Returns all restriction queries, including their names and IDs." }, { "info": { "name": "Datadog List Roles for a Restriction Query", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/logs/config/restriction_queries/:restriction_query_id/roles", "params": [ { "name": "restriction_query_id", "value": "", "type": "path", "description": "The ID of the restriction query." }, { "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": "Returns all roles that have a given restriction query." }, { "info": { "name": "Datadog List Tags by Metric Name", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/metrics/:metric_name/all-tags", "params": [ { "name": "metric_name", "value": "dist.http.endpoint.request", "type": "path", "description": "The name of the metric." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "View indexed tag key-value pairs for a given metric name over the previous hour." }, { "info": { "name": "Datadog List Distinct Metric Volumes by Metric Name", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/metrics/:metric_name/volumes", "params": [ { "name": "metric_name", "value": "dist.http.endpoint.request", "type": "path", "description": "The name of the metric." } ] }, "docs": "View distinct metrics volumes for the given metric name.\n\nCustom metrics generated in-app from other products will return `null` for ingested volumes." }, { "info": { "name": "Datadog List Org Configs", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/org_configs" }, "docs": "Returns all Org Configs (name, description, and value)." }, { "info": { "name": "Datadog List Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/permissions", "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Returns a list of all permissions, including name, description, and ID." }, { "info": { "name": "Datadog List Pipelines", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/obs_pipelines/pipelines", "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." } ] }, "docs": "Retrieve a list of pipelines." }, { "info": { "name": "Datadog List Roles", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/roles", "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": "example_value", "type": "query", "description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`." }, { "name": "filter", "value": "example_value", "type": "query", "description": "Filter all roles by the given string." }, { "name": "filter[id]", "value": "abc-123-def", "type": "query", "description": "Filter all roles by the given list of role IDs." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Returns all roles, including their names and their unique identifiers." }, { "info": { "name": "Datadog List Permissions for a Role", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/roles/:role_id/permissions", "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": "Returns a list of all permissions for a single role." }, { "info": { "name": "Datadog List Users", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/scim/Users", "params": [ { "name": "startIndex", "value": "1", "type": "query", "description": "Specifies the start index to fetch the results (1-indexed)." }, { "name": "count", "value": "20", "type": "query", "description": "Specifies the number of users to be returned." }, { "name": "filter", "value": "example_value", "type": "query", "description": "Specifies the url encoded filter to use to narrow down the results.\nFilter should be of the form `userName eq `." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List users in the organization.\nResults are paginated by `startIndex` and `count` parameters.\nResults can be narrowed down by the `filter` parameter." }, { "info": { "name": "Datadog List Vulnerabilities", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security/vulnerabilities", "params": [ { "name": "page[token]", "value": "b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4", "type": "query", "description": "Its value must come from the `links` section of the response of the first request. Do not manually edit it." }, { "name": "page[number]", "value": "1", "type": "query", "description": "The page number to be retrieved. It should be equal or greater than `1`" }, { "name": "filter[type]", "value": "WeakCipher", "type": "query", "description": "Filter by vulnerability type." }, { "name": "filter[cvss.base.score][`$op`]", "value": "5.5", "type": "query", "description": "Filter by vulnerability base (i.e. from the original advisory) severity score." }, { "name": "filter[cvss.base.severity]", "value": "Medium", "type": "query", "description": "Filter by vulnerability base severity." }, { "name": "filter[cvss.base.vector]", "value": "CVSS:3.0/AV:L/AC:L/PR:L/UI:N/S:U/C:N/I:N/A:H", "type": "query", "description": "Filter by vulnerability base CVSS vector." }, { "name": "filter[cvss.datadog.score][`$op`]", "value": "4.3", "type": "query", "description": "Filter by vulnerability Datadog severity score." }, { "name": "filter[cvss.datadog.severity]", "value": "Medium", "type": "query", "description": "Filter by vulnerability Datadog severity." }, { "name": "filter[cvss.datadog.vector]", "value": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:N/I:N/A:H/E:U/RL:X/RC:X/CR:X/IR:X/AR:X/MAV:L/MAC:H/MPR:L/MUI:N/MS:U/MC:N/MI:N/MA:H", "type": "query", "description": "Filter by vulnerability Datadog CVSS vector." }, { "name": "filter[status]", "value": "Open", "type": "query", "description": "Filter by the status of the vulnerability." }, { "name": "filter[tool]", "value": "SCA", "type": "query", "description": "Filter by the tool of the vulnerability." }, { "name": "filter[library.name]", "value": "linux-aws-5.15", "type": "query", "description": "Filter by library name." }, { "name": "filter[library.version]", "value": "5.15.0", "type": "query", "description": "Filter by library version." }, { "name": "filter[advisory_id]", "value": "TRIVY-CVE-2023-0615", "type": "query", "description": "Filter by advisory ID." }, { "name": "filter[risks.exploitation_probability]", "value": "false", "type": "query", "description": "Filter by exploitation probability." }, { "name": "filter[risks.poc_exploit_available]", "value": "false", "type": "query", "description": "Filter by POC exploit availability." }, { "name": "filter[risks.exploit_available]", "value": "false", "type": "query", "description": "Filter by public exploit availability." }, { "name": "filter[risks.epss.score][`$op`]", "value": "0.00042", "type": "query", "description": "Filter by vulnerability [EPSS](https://www.first.org/epss/) severity score." }, { "name": "filter[risks.epss.severity]", "value": "Low", "type": "query", "description": "Filter by vulnerability [EPSS](https://www.first.org/epss/) severity." }, { "name": "filter[language]", "value": "ubuntu", "type": "query", "description": "Filter by language." }, { "name": "filter[ecosystem]", "value": "Deb", "type": "query", "description": "Filter by ecosystem." }, { "name": "filter[code_location.location]", "value": "com.example.Class:100", "type": "query", "description": "Filter by vulnerability location." }, { "name": "filter[code_location.file_path]", "value": "src/Class.java:100", "type": "query", "description": "Filter by vulnerability file path." }, { "name": "filter[code_location.method]", "value": "FooBar", "type": "query", "description": "Filter by method." }, { "name": "filter[fix_available]", "value": "false", "type": "query", "description": "Filter by fix availability." }, { "name": "filter[repo_digests]", "value": "sha256:0ae7da091191787229d321e3638e39c319a97d6e20f927d465b519d699215bf7", "type": "query", "description": "Filter by vulnerability `repo_digest` (when the vulnerability is related to `Image` asset)." }, { "name": "filter[asset.name]", "value": "datadog-agent", "type": "query", "description": "Filter by asset name." }, { "name": "filter[asset.type]", "value": "Host", "type": "query", "description": "Filter by asset type." }, { "name": "filter[asset.version.first]", "value": "v1.15.1", "type": "query", "description": "Filter by the first version of the asset this vulnerability has been detected on." }, { "name": "filter[asset.version.last]", "value": "v1.15.1", "type": "query", "description": "Filter by the last version of the asset this vulnerability has been detected on." }, { "name": "filter[asset.repository_url]", "value": "github.com/DataDog/datadog-agent.git", "type": "query", "description": "Filter by the repository url associated to the asset." }, { "name": "filter[asset.risks.in_production]", "value": "false", "type": "query", "description": "Filter whether the asset is in production or not." }, { "name": "filter[asset.risks.under_attack]", "value": "false", "type": "query", "description": "Filter whether the asset is under attack or not." }, { "name": "filter[asset.risks.is_publicly_accessible]", "value": "false", "type": "query", "description": "Filter whether the asset is publicly accessible or not." }, { "name": "filter[asset.risks.has_privileged_access]", "value": "false", "type": "query", "description": "Filter whether the asset is publicly accessible or not." }, { "name": "filter[asset.risks.has_access_to_sensitive_data]", "value": "false", "type": "query", "description": "Filter whether the asset has access to sensitive data or not." }, { "name": "filter[asset.environments]", "value": "staging", "type": "query", "description": "Filter by asset environments." }, { "name": "filter[asset.arch]", "value": "arm64", "type": "query", "description": "Filter by asset architecture." }, { "name": "filter[asset.operating_system.name]", "value": "ubuntu", "type": "query", "description": "Filter by asset operating system name." }, { "name": "filter[asset.operating_system.version]", "value": "24.04", "type": "query", "description": "Filter by asset operating system version." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a list of vulnerabilities.\n\n### Pagination\n\nPagination is enabled by default in both `vulnerabilities` and `assets`. The size of the page varies depending on the endpoint and cannot be modified. To automate the request of the next page, you can use the links section in the response.\n\nThis endpoint will return paginated responses. The pages are stored in the links section of the response:\n\n```JSON\n{\n \"data\": [...],\n \"meta\": {...},\n \"links\": {\n \"self\": \"https://.../api/v2/security/vulner" }, { "info": { "name": "Datadog List Rules", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/rules", "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." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List rules." }, { "info": { "name": "Datadog List Standard Patterns", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/sensitive-data-scanner/config/standard-patterns" }, "docs": "Returns all standard patterns." } ] }, { "info": { "name": "Update", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update an Api", "type": "http" }, "http": { "method": "PUT", "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 modify" } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update information about a specific API. The given content will replace all API content of the given ID.\nThe ID is returned by the create API, or can be found in the URL in the API catalog UI.\n" }, { "info": { "name": "Datadog Update a Downtime", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/downtime/:downtime_id", "params": [ { "name": "downtime_id", "value": "00e000000-0000-1234-0000-000000000000", "type": "path", "description": "ID of the downtime to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update a downtime by `downtime_id`." }, { "info": { "name": "Datadog Update Fastly Service", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Fastly service for an account." }, { "info": { "name": "Datadog Update a Powerpack", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/powerpacks/:powerpack_id", "params": [ { "name": "powerpack_id", "value": "abc-123-def", "type": "path", "description": "ID of the powerpack." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update a powerpack." }, { "info": { "name": "Datadog Update User", "type": "http" }, "http": { "method": "PUT", "url": "https://{subdomain}.{site}/api/v2/scim/Users/:user_uuid", "params": [ { "name": "user_uuid", "value": "abc-123-def", "type": "path", "description": "None" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update the user with the given `user_uuid`." }, { "info": { "name": "Datadog Update a User", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/users/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "The ID of the user." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Edit a user. Can only be used with an application key belonging\nto an administrator user." } ] }, { "info": { "name": "Metrics", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update a Span-based Metric", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific span-based metric from your organization.\nReturns the span-based metric object from the request body when the request is successful." }, { "info": { "name": "Datadog Update a Log-based Metric", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific log-based metric from your organization.\nReturns the log-based metric object from the request body when the request is successful." }, { "info": { "name": "Datadog Update a Rum-based Metric", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific rum-based metric from your organization.\nReturns the rum-based metric object from the request body when the request is successful." }, { "info": { "name": "Datadog Submit Metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/series", "headers": [ { "name": "Content-Encoding", "value": "example_value" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards.\nThe maximum payload size is 500 kilobytes (512000 bytes). Compressed payloads must have a decompressed size of less than 5 megabytes (5242880 bytes).\n\nIf you’re submitting metrics directly to the Datadog API without using DogStatsD, expect:\n\n- 64 bits for the timestamp\n- 64 bits for the value\n- 20 bytes for the metric names\n- 50 bytes for the timeseries\n- The full payload is approximately 100 b" } ] }, { "info": { "name": "Retention", "type": "folder" }, "items": [ { "info": { "name": "Datadog Re-order Retention Filters", "type": "http" }, "http": { "method": "PUT", "url": "https://{subdomain}.{site}/api/v2/apm/config/retention-filters-execution-order", "body": { "type": "json", "data": "{}" } }, "docs": "Re-order the execution order of retention filters." } ] }, { "info": { "name": "Filter", "type": "folder" }, "items": [ { "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 Update a Retention Filter", "type": "http" }, "http": { "method": "PUT", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a retention filter from your organization.\n\nDefault filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor) cannot be renamed or removed." }, { "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 Update a Waf Exclusion Filter", "type": "http" }, "http": { "method": "PUT", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific WAF exclusion filter using its identifier.\nReturns the exclusion filter object when the request is successful." }, { "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 Update a Rum Retention Filter", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a RUM retention filter for a RUM application.\nReturns RUM retention filter objects from the request body when the request is successful." }, { "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 Update a Security Filter", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update a specific security filter.\nReturns the security filter object when the request is successful." } ] }, { "info": { "name": "Applications", "type": "folder" }, "items": [ { "info": { "name": "Datadog List Apps", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/app-builder/apps", "params": [ { "name": "limit", "value": "42", "type": "query", "description": "The number of apps to return per page." }, { "name": "page", "value": "42", "type": "query", "description": "The page number to return." }, { "name": "filter[user_name]", "value": "Example Monitor", "type": "query", "description": "Filter apps by the app creator. Usually the user's email." }, { "name": "filter[user_uuid]", "value": "65bb1f25-52e1-4510-9f8d-22d1516ed693", "type": "query", "description": "Filter apps by the app creator's UUID." }, { "name": "filter[name]", "value": "Example Monitor", "type": "query", "description": "Filter by app name." }, { "name": "filter[query]", "value": "avg:system.cpu.user{*}", "type": "query", "description": "Filter apps by the app name or the app creator." }, { "name": "filter[deployed]", "value": "true", "type": "query", "description": "Filter apps by whether they are published." }, { "name": "filter[tags]", "value": "env:production", "type": "query", "description": "Filter apps by tags." }, { "name": "filter[favorite]", "value": "true", "type": "query", "description": "Filter apps by whether you have added them to your favorites." }, { "name": "filter[self_service]", "value": "true", "type": "query", "description": "Filter apps by whether they are enabled for self-service." }, { "name": "sort", "value": "", "type": "query", "description": "The fields and direction to sort apps by." } ] }, "docs": "List all apps, with optional filters and sorting. This endpoint is paginated. Only basic app information such as the app ID, name, and description is returned by this endpoint." }, { "info": { "name": "Datadog Create App", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/app-builder/apps", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new app, returning the app ID." }, { "info": { "name": "Datadog Delete Multiple Apps", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/app-builder/apps", "body": { "type": "json", "data": "{}" } }, "docs": "Delete multiple apps in a single request from a list of app IDs." }, { "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 Update App", "type": "http" }, "http": { "method": "PATCH", "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 update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing app. This creates a new version of the app." }, { "info": { "name": "Datadog Delete App", "type": "http" }, "http": { "method": "DELETE", "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 delete." } ] }, "docs": "Delete a single app." }, { "info": { "name": "Datadog Publish App", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/app-builder/apps/:app_id/deployment", "params": [ { "name": "app_id", "value": "65bb1f25-52e1-4510-9f8d-22d1516ed693", "type": "path", "description": "The ID of the app to publish." } ] }, "docs": "Publish an app for use by other users. To ensure the app is accessible to the correct users, you also need to set a [Restriction Policy](https://docs.datadoghq.com/api/latest/restriction-policies/) on the app if a policy does not yet exist." }, { "info": { "name": "Datadog Unpublish App", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/app-builder/apps/:app_id/deployment", "params": [ { "name": "app_id", "value": "65bb1f25-52e1-4510-9f8d-22d1516ed693", "type": "path", "description": "The ID of the app to unpublish." } ] }, "docs": "Unpublish an app, removing the live version of the app. Unpublishing creates a new instance of a `deployment` object on the app, with a nil `app_version_id` (`00000000-0000-0000-0000-000000000000`). The app can still be updated and published again in the future." }, { "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 Edit an Application Key", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit an application key" }, { "info": { "name": "Datadog Delete an Application Key", "type": "http" }, "http": { "method": "DELETE", "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." } ] }, "docs": "Delete an application key" }, { "info": { "name": "Datadog Create an Application Key for Current User", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/current_user/application_keys", "body": { "type": "json", "data": "{}" } }, "docs": "Create an application key 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 Edit an Application Key Owned by Current User", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit an application key owned by current user" }, { "info": { "name": "Datadog Delete an Application Key Owned by Current User", "type": "http" }, "http": { "method": "DELETE", "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": "Delete an application key owned by current user" }, { "info": { "name": "Datadog Create a New Rum Application", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/rum/applications", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new RUM application in your organization." }, { "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 Update a Rum Application", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/rum/applications/:id", "params": [ { "name": "id", "value": "abc-123-def", "type": "path", "description": "RUM application ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the RUM application with given ID in your organization." }, { "info": { "name": "Datadog Delete a Rum Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/rum/applications/:id", "params": [ { "name": "id", "value": "abc-123-def", "type": "path", "description": "RUM application ID." } ] }, "docs": "Delete an existing RUM application in your organization." }, { "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": "Audit", "type": "folder" }, "items": [ { "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 Search Audit Logs Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/audit/events/search", "body": { "type": "json", "data": "{}" } }, "docs": "List endpoint returns Audit Logs events that match an Audit search query.\n[Results are paginated][1].\n\nUse this endpoint to build complex Audit Logs events filtering and search.\n\n[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination" } ] }, { "info": { "name": "Cases", "type": "folder" }, "items": [ { "info": { "name": "Datadog Search Cases", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/cases", "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[field]", "value": "", "type": "query", "description": "Specify which field to sort" }, { "name": "filter", "value": "status:open (team:case-management OR team:event-management)", "type": "query", "description": "Search query" }, { "name": "sort[asc]", "value": "true", "type": "query", "description": "Specify if order is ascending or not" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Search cases." } ] }, { "info": { "name": "Case", "type": "folder" }, "items": [ { "info": { "name": "Datadog Create a Case", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/cases", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a Case" }, { "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 Update Case Priority", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/cases/:case_id/priority", "params": [ { "name": "case_id", "value": "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504", "type": "path", "description": "Case's UUID or key" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update case priority" }, { "info": { "name": "Datadog Update Case Status", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/cases/:case_id/status", "params": [ { "name": "case_id", "value": "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504", "type": "path", "description": "Case's UUID or key" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update case status" }, { "info": { "name": "Datadog Unarchive Case", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/cases/:case_id/unarchive", "params": [ { "name": "case_id", "value": "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504", "type": "path", "description": "Case's UUID or key" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Unarchive case" }, { "info": { "name": "Datadog Unassign Case", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/cases/:case_id/unassign", "params": [ { "name": "case_id", "value": "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504", "type": "path", "description": "Case's UUID or key" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Unassign case" } ] }, { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "Datadog Remove a Project", "type": "http" }, "http": { "method": "DELETE", "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": "Remove a project using the project's `id`." } ] }, { "info": { "name": "Archive", "type": "folder" }, "items": [ { "info": { "name": "Datadog Archive Case", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/cases/:case_id/archive", "params": [ { "name": "case_id", "value": "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504", "type": "path", "description": "Case's UUID or key" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Archive case" }, { "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 Update Archive Order", "type": "http" }, "http": { "method": "PUT", "url": "https://{subdomain}.{site}/api/v2/logs/config/archive-order", "body": { "type": "json", "data": "{}" } }, "docs": "Update the order of your archives. Since logs are processed sequentially, reordering an archive may change\nthe structure and content of the data processed by other archives.\n\n**Note**: Using the `PUT` method updates your archive's order by replacing the current order\nwith the new one." }, { "info": { "name": "Datadog Create an Archive", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/logs/config/archives", "body": { "type": "json", "data": "{}" } }, "docs": "Create an archive in your organization." }, { "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 Update an Archive", "type": "http" }, "http": { "method": "PUT", "url": "https://{subdomain}.{site}/api/v2/logs/config/archives/:archive_id", "params": [ { "name": "archive_id", "value": "", "type": "path", "description": "The ID of the archive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a given archive configuration.\n\n**Note**: Using this method updates your archive configuration by **replacing**\nyour current configuration with the new one sent to your Datadog organization." }, { "info": { "name": "Datadog Delete an Archive", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a given archive from your organization." }, { "info": { "name": "Datadog List Read Roles for an Archive", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/logs/config/archives/:archive_id/readers", "params": [ { "name": "archive_id", "value": "", "type": "path", "description": "The ID of the archive." } ] }, "docs": "Returns all read roles a given archive is restricted to." }, { "info": { "name": "Datadog Grant Role to an Archive", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/logs/config/archives/:archive_id/readers", "params": [ { "name": "archive_id", "value": "", "type": "path", "description": "The ID of the archive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a read role to an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))" }, { "info": { "name": "Datadog Revoke Role from an Archive", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/logs/config/archives/:archive_id/readers", "params": [ { "name": "archive_id", "value": "", "type": "path", "description": "The ID of the archive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a role from an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))" } ] }, { "info": { "name": "Assign", "type": "folder" }, "items": [ { "info": { "name": "Datadog Assign Case", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/cases/:case_id/assign", "params": [ { "name": "case_id", "value": "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504", "type": "path", "description": "Case's UUID or key" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Assign case to a user" } ] }, { "info": { "name": "Entities", "type": "folder" }, "items": [ { "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": "Entity", "type": "folder" }, "items": [ { "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": "Events", "type": "folder" }, "items": [ { "info": { "name": "Datadog Send Pipeline Event", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/ci/pipeline", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Send your pipeline event to your Datadog platform over HTTP. For details about how pipeline executions are modeled and what execution types we support, see [Pipeline Data Model And Execution Types](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/).\n\nPipeline events can be submitted with a timestamp that is up to 18 hours in the past." }, { "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 Search Pipelines Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/ci/pipelines/events/search", "body": { "type": "json", "data": "{}" }, "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 build complex events filtering and search." }, { "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 Search Tests Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/ci/tests/events/search", "body": { "type": "json", "data": "{}" }, "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 build complex events filtering and search." }, { "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 Send an Incident Event for Dora Metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/dora/incident", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Use this API endpoint to provide failure data for DORA metrics.\n\nThis is necessary for:\n- Change Failure Rate\n- Time to Restore" }, { "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 Post an Event", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/events", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "This endpoint allows you to post events.\n\n✅ **Only events with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking) for more details.\n\n❌ For use cases involving other event categories, please use the V1 endpoint." }, { "info": { "name": "Datadog Search Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/events/search", "body": { "type": "json", "data": "{}" } }, "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 build complex events filtering and search." }, { "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 Search Rum Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/rum/events/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List endpoint returns RUM events that match a RUM search query.\n[Results are paginated][1].\n\nUse this endpoint to build complex RUM events filtering and search.\n\n[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination" } ] }, { "info": { "name": "Aggregate", "type": "folder" }, "items": [ { "info": { "name": "Datadog Aggregate Pipelines Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/ci/pipelines/analytics/aggregate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries." }, { "info": { "name": "Datadog Aggregate Tests Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/ci/tests/analytics/aggregate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "The API endpoint to aggregate CI Visibility test events into buckets of computed metrics and timeseries." }, { "info": { "name": "Datadog Aggregate Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/logs/analytics/aggregate", "body": { "type": "json", "data": "{}" } }, "docs": "The API endpoint to aggregate events into buckets and compute metrics and timeseries." }, { "info": { "name": "Datadog Aggregate Rum Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/rum/analytics/aggregate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries." }, { "info": { "name": "Datadog Aggregate Spans", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/spans/analytics/aggregate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "The API endpoint to aggregate spans into buckets and compute metrics and timeseries.\nThis endpoint is rate limited to `300` requests per hour." } ] }, { "info": { "name": "Custom", "type": "folder" }, "items": [ { "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 Update a Custom Framework", "type": "http" }, "http": { "method": "PUT", "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" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update a custom framework." }, { "info": { "name": "Datadog Delete a Custom Framework", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a custom framework." }, { "info": { "name": "Datadog List Custom Costs Files", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/cost/custom_costs", "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List the Custom Costs files." }, { "info": { "name": "Datadog Upload Custom Costs File", "type": "http" }, "http": { "method": "PUT", "url": "https://{subdomain}.{site}/api/v2/cost/custom_costs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Upload a Custom Costs file." }, { "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 Delete Custom Costs File", "type": "http" }, "http": { "method": "DELETE", "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": "Delete the specified Custom Costs file." }, { "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 Update a Custom Destination", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the given fields of a specific custom destination in your organization." }, { "info": { "name": "Datadog Delete a Custom Destination", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a specific custom destination in 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 Update a Waf Custom Rule", "type": "http" }, "http": { "method": "PUT", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific WAF custom Rule.\nReturns the Custom Rule object when the request is successful." }, { "info": { "name": "Datadog Delete a Waf Custom Rule", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a specific WAF custom rule." } ] }, { "info": { "name": "Resource", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update Resource Filters", "type": "http" }, "http": { "method": "PUT", "url": "https://{subdomain}.{site}/api/v2/cloud_security_management/resource_filters", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update resource filters." } ] }, { "info": { "name": "Cloud", "type": "folder" }, "items": [ { "info": { "name": "Datadog List Cloud Cost Management Aws Cur Configs", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/cost/aws_cur_config", "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List the AWS CUR configs." }, { "info": { "name": "Datadog Create Cloud Cost Management Aws Cur Config", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/cost/aws_cur_config", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a Cloud Cost Management account for an AWS CUR config." }, { "info": { "name": "Datadog Update Cloud Cost Management Aws Cur Config", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/cost/aws_cur_config/:cloud_account_id", "params": [ { "name": "cloud_account_id", "value": "", "type": "path", "description": "Cloud Account id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update the status (active/archived) and/or account filtering configuration of an AWS CUR config." }, { "info": { "name": "Datadog Delete Cloud Cost Management Aws Cur Config", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/cost/aws_cur_config/:cloud_account_id", "params": [ { "name": "cloud_account_id", "value": "", "type": "path", "description": "Cloud Account id." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Archive a Cloud Cost Management Account." }, { "info": { "name": "Datadog List Cloud Cost Management Azure Configs", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/cost/azure_uc_config", "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List the Azure configs." }, { "info": { "name": "Datadog Create Cloud Cost Management Azure Configs", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/cost/azure_uc_config", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a Cloud Cost Management account for an Azure config." }, { "info": { "name": "Datadog Update Cloud Cost Management Azure Config", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/cost/azure_uc_config/:cloud_account_id", "params": [ { "name": "cloud_account_id", "value": "", "type": "path", "description": "Cloud Account id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update the status of an Azure config (active/archived)." }, { "info": { "name": "Datadog Delete Cloud Cost Management Azure Config", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/cost/azure_uc_config/:cloud_account_id", "params": [ { "name": "cloud_account_id", "value": "", "type": "path", "description": "Cloud Account id." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Archive a Cloud Cost Management Account." } ] }, { "info": { "name": "Budget", "type": "folder" }, "items": [ { "info": { "name": "Datadog Create or Update a Budget", "type": "http" }, "http": { "method": "PUT", "url": "https://{subdomain}.{site}/api/v2/cost/budget", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Create a new budget or update an existing one." }, { "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 Delete a Budget", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a budget." } ] }, { "info": { "name": "Budgets", "type": "folder" }, "items": [ { "info": { "name": "Datadog List Budgets", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/cost/budgets", "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List budgets." } ] }, { "info": { "name": "Active", "type": "folder" }, "items": [ { "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 List Active Tags and Aggregations", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/metrics/:metric_name/active-configurations", "params": [ { "name": "metric_name", "value": "dist.http.endpoint.request", "type": "path", "description": "The name of the metric." }, { "name": "window[seconds]", "value": "7200", "type": "query", "description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)." } ] }, "docs": "List tags and aggregations that are actively queried on dashboards, notebooks, monitors, the Metrics Explorer, and using the API for a given metric name." }, { "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": "Cost", "type": "folder" }, "items": [ { "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": "Agents", "type": "folder" }, "items": [ { "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 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": "Accounts", "type": "folder" }, "items": [ { "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 List All Gcp Sts-enabled Service Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integration/gcp/accounts" }, "docs": "List all GCP STS-enabled service accounts configured in your Datadog account." }, { "info": { "name": "Datadog List Cloudflare Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integrations/cloudflare/accounts" }, "docs": "List Cloudflare accounts." }, { "info": { "name": "Datadog List Confluent Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integrations/confluent-cloud/accounts" }, "docs": "List Confluent accounts." }, { "info": { "name": "Datadog List Fastly Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integrations/fastly/accounts" }, "docs": "List Fastly accounts." }, { "info": { "name": "Datadog List Okta Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integrations/okta/accounts" }, "docs": "List Okta accounts." } ] }, { "info": { "name": "Analysis", "type": "folder" }, "items": [ { "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": "Dashboards", "type": "folder" }, "items": [ { "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 Update Items of a Dashboard List", "type": "http" }, "http": { "method": "PUT", "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 update items from." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update dashboards of an existing dashboard list." }, { "info": { "name": "Datadog Delete Items from a Dashboard List", "type": "http" }, "http": { "method": "DELETE", "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 delete items from." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete dashboards from an existing dashboard list." } ] }, { "info": { "name": "Add", "type": "folder" }, "items": [ { "info": { "name": "Datadog Add Items to a Dashboard List", "type": "http" }, "http": { "method": "POST", "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 add items to." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add dashboards to an existing dashboard list." }, { "info": { "name": "Datadog Add Fastly Service", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/integrations/fastly/accounts/:account_id/services", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Fastly Account id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Fastly service for an account." }, { "info": { "name": "Datadog Add a User to a Role", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/roles/:role_id/users", "params": [ { "name": "role_id", "value": "", "type": "path", "description": "The unique identifier of the role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Adds a user to a role." }, { "info": { "name": "Datadog Add a User to a Team", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/team/:team_id/memberships", "params": [ { "name": "team_id", "value": "abc-123-def", "type": "path", "description": "None" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Add a user to a team." } ] }, { "info": { "name": "Domain", "type": "folder" }, "items": [ { "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 Sets Domain Allowlist", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/domain_allowlist", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update the domain allowlist for an organization." } ] }, { "info": { "name": "Deployments", "type": "folder" }, "items": [ { "info": { "name": "Datadog Send a Deployment Event for Dora Metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/dora/deployment", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Use this API endpoint to provide data about deployments for DORA metrics.\n\nThis is necessary for:\n- Deployment Frequency\n- Change Lead Time\n- Change Failure Rate" }, { "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": "Schedules", "type": "folder" }, "items": [ { "info": { "name": "Datadog Schedule a Downtime", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/downtime", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Schedule a downtime." }, { "info": { "name": "Datadog Update On-call Schedule", "type": "http" }, "http": { "method": "PUT", "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" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update a new On-Call schedule" } ] }, { "info": { "name": "Cancel", "type": "folder" }, "items": [ { "info": { "name": "Datadog Cancel a Downtime", "type": "http" }, "http": { "method": "DELETE", "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 cancel." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Cancel a downtime.\n\n**Note**: Downtimes canceled through the API are no longer active, but are retained for approximately two days before being permanently removed. The downtime may still appear in search results until it is permanently removed." }, { "info": { "name": "Datadog Cancel a Historical Job", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/siem-historical-detections/jobs/:job_id/cancel", "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": "Cancel a historical job." }, { "info": { "name": "Datadog Cancel a Workflow Instance", "type": "http" }, "http": { "method": "PUT", "url": "https://{subdomain}.{site}/api/v2/workflows/:workflow_id/instances/:instance_id/cancel", "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." } ] }, "docs": "Cancels a specific execution of a given workflow. This API requires an application key scoped with the workflows_run permission." } ] }, { "info": { "name": "Incident", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update an Incident Type", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update an incident type." }, { "info": { "name": "Datadog Update an Incident Todo", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update an incident todo." } ] }, { "info": { "name": "Search", "type": "folder" }, "items": [ { "info": { "name": "Datadog Search for Incidents", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/incidents/search", "params": [ { "name": "include", "value": "", "type": "query", "description": "Specifies which types of related objects should be included in the response." }, { "name": "query", "value": "", "type": "query", "description": "Specifies which incidents should be returned. The query can contain any number of incident facets\njoined by `ANDs`, along with multiple values for each of those facets joined by `OR`s. For\nexample: `state:active AND severity:(SEV-2 OR SEV-1)`." }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the order of returned incidents." }, { "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": "Search for incidents matching a certain query." }, { "info": { "name": "Datadog Search Spans", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/spans/events/search", "body": { "type": "json", "data": "{}" }, "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 build complex spans filtering and search.\nThis endpoint is rate limited to `300` requests per hour.\n\n[1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api" } ] }, { "info": { "name": "Existing", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update an Existing Incident", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Updates an incident. Provide only the attributes that should be updated as this request is a partial update." }, { "info": { "name": "Datadog Update an Existing Incident Integration Metadata", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update an existing incident integration metadata." }, { "info": { "name": "Datadog Update an Existing Rule", "type": "http" }, "http": { "method": "PUT", "url": "https://{subdomain}.{site}/api/v2/scorecard/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path", "description": "The ID of the rule." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Updates an existing rule." }, { "info": { "name": "Datadog Update an Existing Rule", "type": "http" }, "http": { "method": "PUT", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path", "description": "The ID of the rule." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update an existing rule. When updating `cases`, `queries` or `options`, the whole field\nmust be included. For example, when modifying a query all queries must be included.\nDefault rules can only be updated to be enabled, to change notifications, or to update\nthe tags (default tags cannot be removed)." }, { "info": { "name": "Datadog Test an Existing Rule", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/rules/:rule_id/test", "params": [ { "name": "rule_id", "value": "", "type": "path", "description": "The ID of the rule." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Test an existing rule." }, { "info": { "name": "Datadog Update an Existing Incident Service", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/services/:service_id", "params": [ { "name": "service_id", "value": "", "type": "path", "description": "The ID of the incident service." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Updates an existing incident service. Only provide the attributes which should be updated as this request is a partial update." }, { "info": { "name": "Datadog Update an Existing Incident Team", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/teams/:team_id", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The ID of the incident team." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Updates an existing incident team. Only provide the attributes which should be updated as this request is a partial update." }, { "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 Update an Existing Workflow", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/workflows/:workflow_id", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The ID of the workflow." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a workflow by ID. This API requires an application key scoped with the `workflows_write` permission." } ] }, { "info": { "name": "Attachments", "type": "folder" }, "items": [ { "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 Create, Update, and Delete Incident Attachments", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The bulk update endpoint for creating, updating, and deleting attachments for a given incident." } ] }, { "info": { "name": "Integration", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update an Aws Integration", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an AWS Account Integration Config by config ID." } ] }, { "info": { "name": "Available", "type": "folder" }, "items": [ { "info": { "name": "Datadog List Available Namespaces", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integration/aws/available_namespaces" }, "docs": "Get a list of available AWS CloudWatch namespaces that can send metrics to Datadog." } ] }, { "info": { "name": "External", "type": "folder" }, "items": [ { "info": { "name": "Datadog Generate a New External Id", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/integration/aws/generate_new_external_id" }, "docs": "Generate a new external ID for AWS role-based authentication." } ] }, { "info": { "name": "Account", "type": "folder" }, "items": [ { "info": { "name": "Datadog Create a New Entry for Your Service Account", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/integration/gcp/accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new entry within Datadog for your STS enabled service account." }, { "info": { "name": "Datadog Update Sts Service Account", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/integration/gcp/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Your GCP STS enabled service account's unique ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an STS enabled service account." }, { "info": { "name": "Datadog Delete an Sts Enabled Gcp Account", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/integration/gcp/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Your GCP STS enabled service account's unique ID." } ] }, "docs": "Delete an STS enabled GCP account from within Datadog." }, { "info": { "name": "Datadog List Delegate Account", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integration/gcp/sts_delegate" }, "docs": "List your Datadog-GCP STS delegate account configured in your Datadog account." }, { "info": { "name": "Datadog Add Cloudflare Account", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/integrations/cloudflare/accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Cloudflare account." }, { "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 Update Cloudflare Account", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/integrations/cloudflare/accounts/:account_id", "params": [ { "name": "account_id", "value": "abc-123-def", "type": "path", "description": "None" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Cloudflare account." }, { "info": { "name": "Datadog Delete Cloudflare Account", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/integrations/cloudflare/accounts/:account_id", "params": [ { "name": "account_id", "value": "abc-123-def", "type": "path", "description": "None" } ] }, "docs": "Delete a Cloudflare account." }, { "info": { "name": "Datadog Add Confluent Account", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/integrations/confluent-cloud/accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Confluent 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 Update Confluent Account", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/integrations/confluent-cloud/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Confluent Account ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Confluent account with the provided account ID." }, { "info": { "name": "Datadog Delete Confluent Account", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/integrations/confluent-cloud/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Confluent Account ID." } ] }, "docs": "Delete a Confluent account with the provided account ID." }, { "info": { "name": "Datadog List Confluent Account Resources", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Confluent Account ID." } ] }, "docs": "Get a Confluent resource for the account associated with the provided ID." }, { "info": { "name": "Datadog Add Resource to Confluent Account", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/integrations/confluent-cloud/accounts/:account_id/resources", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Confluent Account ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Confluent resource for the account associated with the provided 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 Update Resource in Confluent Account", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Confluent resource with the provided resource id for the account associated with the provided account ID." }, { "info": { "name": "Datadog Delete Resource from Confluent Account", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a Confluent resource with the provided resource id for the account associated with the provided account ID." }, { "info": { "name": "Datadog Add Fastly Account", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/integrations/fastly/accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Fastly account." }, { "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 Update Fastly Account", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/integrations/fastly/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Fastly Account id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Fastly account." }, { "info": { "name": "Datadog Delete Fastly Account", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/integrations/fastly/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Fastly Account id." } ] }, "docs": "Delete a Fastly account." }, { "info": { "name": "Datadog Add Okta Account", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/integrations/okta/accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Create an Okta 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 Update Okta Account", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/integrations/okta/accounts/:account_id", "params": [ { "name": "account_id", "value": "abc-123-def", "type": "path", "description": "None" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Okta account." }, { "info": { "name": "Datadog Delete Okta Account", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/integrations/okta/accounts/:account_id", "params": [ { "name": "account_id", "value": "abc-123-def", "type": "path", "description": "None" } ] }, "docs": "Delete an Okta account." }, { "info": { "name": "Datadog Create a Service Account", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/service_accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Create a service account for your organization." }, { "info": { "name": "Datadog List Application Keys for This Service Account", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/service_accounts/:service_account_id/application_keys", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "The ID of the service account." }, { "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." } ] }, "docs": "List all application keys available for this service account." }, { "info": { "name": "Datadog Create an Application Key for This Service Account", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/service_accounts/:service_account_id/application_keys", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "The ID of the service account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an application key for this service account." }, { "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 Edit an Application Key for This Service Account", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit an application key owned by this service account." }, { "info": { "name": "Datadog Delete an Application Key for This Service Account", "type": "http" }, "http": { "method": "DELETE", "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": "Delete an application key owned by this service account." }, { "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 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": "Channel", "type": "folder" }, "items": [ { "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": "Handle", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update Tenant-based Handle", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a tenant-based handle from the Datadog Microsoft Teams integration." }, { "info": { "name": "Datadog Update Workflows Webhook Handle", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Workflows webhook handle from the Datadog Microsoft Teams integration." } ] }, { "info": { "name": "Objects", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update a Single Service Object", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a single service object in the Datadog Opsgenie integration." } ] }, { "info": { "name": "Ip", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update Ip Allowlist", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/ip_allowlist", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Edit the entries in the IP allowlist, and enable or disable it." } ] }, { "info": { "name": "Logs", "type": "folder" }, "items": [ { "info": { "name": "Datadog Send Logs", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/logs", "headers": [ { "name": "Content-Encoding", "value": "example_value" } ], "params": [ { "name": "ddtags", "value": "env:prod,user:my-user", "type": "query", "description": "Log tags can be passed as query parameters with `text/plain` content type." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Send your logs to your Datadog platform over HTTP. Limits per HTTP request are:\n\n- Maximum content size per payload (uncompressed): 5MB\n- Maximum size for a single log: 1MB\n- Maximum array size if sending multiple logs in an array: 1000 entries\n\nAny log exceeding 1MB is accepted and truncated by Datadog:\n- For a single log request, the API truncates the log at 1MB and returns a 2xx.\n- For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx.\n\nD" }, { "info": { "name": "Datadog Search Logs (post)", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/logs/events/search", "body": { "type": "json", "data": "{}" } }, "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": "Queries", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update a Restriction Query", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit a restriction query." }, { "info": { "name": "Datadog Revoke Role from a Restriction Query", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/logs/config/restriction_queries/:restriction_query_id/roles", "params": [ { "name": "restriction_query_id", "value": "", "type": "path", "description": "The ID of the restriction query." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a role from a restriction query." } ] }, { "info": { "name": "Grants", "type": "folder" }, "items": [ { "info": { "name": "Datadog Grant Role to a Restriction Query", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/logs/config/restriction_queries/:restriction_query_id/roles", "params": [ { "name": "restriction_query_id", "value": "", "type": "path", "description": "The ID of the restriction query." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a role to a restriction query." }, { "info": { "name": "Datadog Grant Permission to a Role", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/roles/:role_id/permissions", "params": [ { "name": "role_id", "value": "", "type": "path", "description": "The unique identifier of the role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Adds a permission to a role." } ] }, { "info": { "name": "Configure", "type": "folder" }, "items": [ { "info": { "name": "Datadog Configure Tags for Multiple Metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/metrics/config/bulk-tags", "body": { "type": "json", "data": "{}" } }, "docs": "Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.\nMetrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations.\nResults can be sent to a set of account email addresses, just like the same operation in the Datadog web app.\nIf multiple calls include the same metric, the last configuration applied (not by submit order) is used, do not\nexpect deterministic ordering of concurr" } ] }, { "info": { "name": "Assets", "type": "folder" }, "items": [ { "info": { "name": "Datadog Related Assets to a Metric", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/metrics/:metric_name/assets", "params": [ { "name": "metric_name", "value": "dist.http.endpoint.request", "type": "path", "description": "The name of the metric." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Returns dashboards, monitors, notebooks, and SLOs that a metric is stored in, if any. Updated every 24 hours." }, { "info": { "name": "Datadog List Vulnerable Assets", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security/assets", "params": [ { "name": "page[token]", "value": "b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4", "type": "query", "description": "Its value must come from the `links` section of the response of the first request. Do not manually edit it." }, { "name": "page[number]", "value": "1", "type": "query", "description": "The page number to be retrieved. It should be equal or greater than `1`" }, { "name": "filter[name]", "value": "datadog-agent", "type": "query", "description": "Filter by name." }, { "name": "filter[type]", "value": "Host", "type": "query", "description": "Filter by type." }, { "name": "filter[version.first]", "value": "v1.15.1", "type": "query", "description": "Filter by the first version of the asset since it has been vulnerable." }, { "name": "filter[version.last]", "value": "v1.15.1", "type": "query", "description": "Filter by the last detected version of the asset." }, { "name": "filter[repository_url]", "value": "github.com/DataDog/datadog-agent.git", "type": "query", "description": "Filter by the repository url associated to the asset." }, { "name": "filter[risks.in_production]", "value": "false", "type": "query", "description": "Filter whether the asset is in production or not." }, { "name": "filter[risks.under_attack]", "value": "false", "type": "query", "description": "Filter whether the asset (Service) is under attack or not." }, { "name": "filter[risks.is_publicly_accessible]", "value": "false", "type": "query", "description": "Filter whether the asset (Host) is publicly accessible or not." }, { "name": "filter[risks.has_privileged_access]", "value": "false", "type": "query", "description": "Filter whether the asset (Host) has privileged access or not." }, { "name": "filter[risks.has_access_to_sensitive_data]", "value": "false", "type": "query", "description": "Filter whether the asset (Host) has access to sensitive data or not." }, { "name": "filter[environments]", "value": "staging", "type": "query", "description": "Filter by environment." }, { "name": "filter[arch]", "value": "arm64", "type": "query", "description": "Filter by architecture." }, { "name": "filter[operating_system.name]", "value": "ubuntu", "type": "query", "description": "Filter by operating system name." }, { "name": "filter[operating_system.version]", "value": "24.04", "type": "query", "description": "Filter by operating system version." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a list of vulnerable assets.\n\n### Pagination\n\nPlease review the [Pagination section for the \"List Vulnerabilities\"](#pagination) endpoint.\n\n### Filtering\n\nPlease review the [Filtering section for the \"List Vulnerabilities\"](#filtering) endpoint.\n\n### Metadata\n\nPlease review the [Metadata section for the \"List Vulnerabilities\"](#metadata) endpoint.\n" } ] }, { "info": { "name": "Cardinality", "type": "folder" }, "items": [ { "info": { "name": "Datadog Tag Configuration Cardinality Estimator", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/metrics/:metric_name/estimate", "params": [ { "name": "metric_name", "value": "dist.http.endpoint.request", "type": "path", "description": "The name of the metric." }, { "name": "filter[groups]", "value": "app,host", "type": "query", "description": "Filtered tag keys that the metric is configured to query with." }, { "name": "filter[hours_ago]", "value": "49", "type": "query", "description": "The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours." }, { "name": "filter[num_aggregations]", "value": "1", "type": "query", "description": "Deprecated. Number of aggregations has no impact on volume." }, { "name": "filter[pct]", "value": "true", "type": "query", "description": "A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators." }, { "name": "filter[timespan_h]", "value": "6", "type": "query", "description": "A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour." } ] }, "docs": "Returns the estimated cardinality for a metric with a given tag, percentile and number of aggregations configuration using Metrics without Limits™." } ] }, { "info": { "name": "Configuration", "type": "folder" }, "items": [ { "info": { "name": "Datadog List Tag Configuration by Name", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/metrics/:metric_name/tags", "params": [ { "name": "metric_name", "value": "dist.http.endpoint.request", "type": "path", "description": "The name of the metric." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Returns the tag configuration for the given metric name." }, { "info": { "name": "Datadog Create a Tag Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/metrics/:metric_name/tags", "params": [ { "name": "metric_name", "value": "dist.http.endpoint.request", "type": "path", "description": "The name of the metric." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.\nOptionally, include percentile aggregations on any distribution metric. By setting `exclude_tags_mode`\nto true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are\nnot queryable. Can only be used with application keys of users with the `Manage Tags for Metrics`\npermission." }, { "info": { "name": "Datadog Update a Tag Configuration", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/metrics/:metric_name/tags", "params": [ { "name": "metric_name", "value": "dist.http.endpoint.request", "type": "path", "description": "The name of the metric." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations\nof a count, rate, or gauge metric. By setting `exclude_tags_mode` to true the behavior is changed\nfrom an allow-list to a deny-list, and tags in the defined list will not be queryable.\nCan only be used with application keys from users with the `Manage Tags for Metrics` permission. This endpoint requires\na tag configuration to be created first." }, { "info": { "name": "Datadog Delete a Tag Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/metrics/:metric_name/tags", "params": [ { "name": "metric_name", "value": "dist.http.endpoint.request", "type": "path", "description": "The name of the metric." } ] }, "docs": "Deletes a metric's tag configuration. Can only be used with application\nkeys from users with the `Manage Tags for Metrics` permission." }, { "info": { "name": "Datadog Create a Monitor Configuration Policy", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/monitor/policy", "body": { "type": "json", "data": "{}" } }, "docs": "Create a monitor configuration policy." }, { "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 Edit a Monitor Configuration Policy", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit a monitor configuration policy." }, { "info": { "name": "Datadog Delete a Monitor Configuration Policy", "type": "http" }, "http": { "method": "DELETE", "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." } ] }, "docs": "Delete a monitor configuration policy." } ] }, { "info": { "name": "Monitor", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update a Monitor Notification Rule", "type": "http" }, "http": { "method": "PATCH", "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 update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Updates a monitor notification rule by `rule_id`." } ] }, { "info": { "name": "Devices", "type": "folder" }, "items": [ { "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 Update the Tags for a Device", "type": "http" }, "http": { "method": "PATCH", "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 update tags for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the tags for a device." } ] }, { "info": { "name": "Aggregated", "type": "folder" }, "items": [ { "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": "Policies", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update On-call Escalation Policy", "type": "http" }, "http": { "method": "PUT", "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`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update an On-Call escalation policy" }, { "info": { "name": "Datadog Update a Workload Protection Policy", "type": "http" }, "http": { "method": "PATCH", "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific Workload Protection policy.\nReturns the policy object when the request is successful.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below." }, { "info": { "name": "Datadog Update a Restriction Policy", "type": "http" }, "http": { "method": "POST", "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`." }, { "name": "allow_self_lockout", "value": "true", "type": "query", "description": "Allows admins (users with the `user_access_manage` permission) to remove their own access from the resource if set to `true`. By default, this is set to `false`, preventing admins from locking themselves out." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Updates the restriction policy associated with a resource.\n\n#### Supported resources\nRestriction policies can be applied to the following resources:\n- Dashboards: `dashboard`\n- Integration Accounts: `integration-account`\n- Integration Services: `integration-service`\n- Integration Webhooks: `integration-webhook`\n- Notebooks: `notebook`\n- Powerpacks: `powerpack`\n- Reference Tables: `reference-table`\n- Security Rules: `security-rule`\n- Service Level Objectives: `slo`\n- Synthetic Global Variables: `" } ] }, { "info": { "name": "Acknowledge", "type": "folder" }, "items": [ { "info": { "name": "Datadog Acknowledge On-call Page", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/on-call/pages/:page_id/acknowledge", "params": [ { "name": "page_id", "value": "15e74b8b-f865-48d0-bcc5-453323ed2c8f", "type": "path", "description": "The page ID." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Acknowledges an On-Call Page.\n" } ] }, { "info": { "name": "Escalate", "type": "folder" }, "items": [ { "info": { "name": "Datadog Escalate On-call Page", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/on-call/pages/:page_id/escalate", "params": [ { "name": "page_id", "value": "15e74b8b-f865-48d0-bcc5-453323ed2c8f", "type": "path", "description": "The page ID." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Escalates an On-Call Page.\n" } ] }, { "info": { "name": "Pages", "type": "folder" }, "items": [ { "info": { "name": "Datadog Resolve On-call Page", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/on-call/pages/:page_id/resolve", "params": [ { "name": "page_id", "value": "15e74b8b-f865-48d0-bcc5-453323ed2c8f", "type": "path", "description": "The page ID." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Resolves an On-Call Page.\n" } ] }, { "info": { "name": "Routing", "type": "folder" }, "items": [ { "info": { "name": "Datadog Set On-call Team Routing Rules", "type": "http" }, "http": { "method": "PUT", "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`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Set a team's On-Call routing rules" } ] }, { "info": { "name": "Specific", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update a Specific Org Config", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the value of a specific Org Config." } ] }, { "info": { "name": "Findings", "type": "folder" }, "items": [ { "info": { "name": "Datadog List Findings", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/posture_management/findings", "params": [ { "name": "page[limit]", "value": "50", "type": "query", "description": "Limit the number of findings returned. Must be <= 1000." }, { "name": "snapshot_timestamp", "value": "1678721573794", "type": "query", "description": "Return findings for a given snapshot of time (Unix ms)." }, { "name": "page[cursor]", "value": "eyJhZnRlciI6IkFRQUFBWWJiaEJXQS1OY1dqUUFBQUFCQldXSmlhRUpYUVVGQlJFSktkbTlDTUdaWFRVbDNRVUUiLCJ2YWx1ZXMiOlsiY3JpdGljYWwiXX0=", "type": "query", "description": "Return the next page of findings pointed to by the cursor." }, { "name": "filter[tags]", "value": "filter[tags]=cloud_provider:aws&filter[tags]=aws_account:999999999999", "type": "query", "description": "Return findings that have these associated tags (repeatable)." }, { "name": "filter[evaluation_changed_at]", "value": ">=1678721573794", "type": "query", "description": "Return findings that have changed from pass to fail or vice versa on a specified date (Unix ms) or date range (using comparison operators)." }, { "name": "filter[muted]", "value": "true", "type": "query", "description": "Set to `true` to return findings that are muted. Set to `false` to return unmuted findings." }, { "name": "filter[rule_id]", "value": "abc-123-def", "type": "query", "description": "Return findings for the specified rule ID." }, { "name": "filter[rule_name]", "value": "Example Monitor", "type": "query", "description": "Return findings for the specified rule." }, { "name": "filter[resource_type]", "value": "metric alert", "type": "query", "description": "Return only findings for the specified resource type." }, { "name": "filter[discovery_timestamp]", "value": ">=1678721573794", "type": "query", "description": "Return findings that were found on a specified date (Unix ms) or date range (using comparison operators)." }, { "name": "filter[evaluation]", "value": "pass", "type": "query", "description": "Return only `pass` or `fail` findings." }, { "name": "filter[status]", "value": "critical", "type": "query", "description": "Return only findings with the specified status." }, { "name": "filter[vulnerability_type]", "value": "misconfiguration", "type": "query", "description": "Return findings that match the selected vulnerability types (repeatable)." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a list of findings. These include both misconfigurations and identity risks.\n\n**Note**: To filter and return only identity risks, add the following query parameter: `?filter[tags]=dd_rule_type:ciem`\n\n### Filtering\n\nFilters can be applied by appending query parameters to the URL.\n\n - Using a single filter: `?filter[attribute_key]=attribute_value`\n - Chaining filters: `?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...`\n - Filtering on tags: `?filter[tags]=tag_k" } ] }, { "info": { "name": "Batch", "type": "folder" }, "items": [ { "info": { "name": "Datadog Mute or Unmute a Batch of Findings", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/posture_management/findings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Mute or unmute findings." }, { "info": { "name": "Datadog Create Outcomes Batch", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/scorecard/outcomes/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Sets multiple service-rule outcomes in a single batched request." } ] }, { "info": { "name": "Finding", "type": "folder" }, "items": [ { "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": "Across", "type": "folder" }, "items": [ { "info": { "name": "Datadog Query Scalar Data Across Multiple Products", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/query/scalar", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Query scalar values (as seen on Query Value, Table, and Toplist widgets).\nMultiple data sources are supported with the ability to\nprocess the data using formulas and functions." }, { "info": { "name": "Datadog Query Timeseries Data Across Multiple Products", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/query/timeseries", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Query timeseries data across various data sources and\nprocess the data by applying formulas and functions." } ] }, { "info": { "name": "Agent", "type": "folder" }, "items": [ { "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 Create a Workload Protection Agent Rule", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/cws/agent_rules", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Workload Protection agent rule with the given parameters.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below." }, { "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 Update a Workload Protection Agent Rule", "type": "http" }, "http": { "method": "PATCH", "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific Workload Protection Agent rule.\nReturns the agent rule object when the request is successful.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below." }, { "info": { "name": "Datadog Delete a Workload Protection Agent Rule", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a specific Workload Protection agent rule.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below." }, { "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 Create a Workload Protection Agent Rule (us1-fed)", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/cloud_workload_security/agent_rules", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new agent rule with the given parameters.\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 Update a Workload Protection Agent Rule (us1-fed)", "type": "http" }, "http": { "method": "PATCH", "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific agent rule.\nReturns the agent rule object when the request is successful.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site." }, { "info": { "name": "Datadog Delete a Workload Protection Agent Rule (us1-fed)", "type": "http" }, "http": { "method": "DELETE", "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": "Delete a specific agent rule.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site." } ] }, { "info": { "name": "Download", "type": "folder" }, "items": [ { "info": { "name": "Datadog Download the Workload Protection Policy", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/cws/policy/download" }, "docs": "The download endpoint generates a Workload Protection policy file from your currently active\nWorkload Protection agent rules, and downloads them as a `.policy` file. This file can then be deployed to\nyour agents to update the policy running in your environment.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below." }, { "info": { "name": "Datadog Download the Workload Protection Policy (us1-fed)", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security/cloud_workload/policy/download" }, "docs": "The download endpoint generates a Workload Protection policy file from your currently active\nWorkload Protection agent rules, and downloads them as a `.policy` file. This file can then be deployed to\nyour agents to update the policy running in your environment.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site." } ] }, { "info": { "name": "Observability", "type": "folder" }, "items": [ { "info": { "name": "Datadog Validate an Observability Pipeline", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/obs_pipelines/pipelines/validate", "body": { "type": "json", "data": "{}" } }, "docs": "Validates a pipeline configuration without creating or updating any resources.\nReturns a list of validation errors, if any.\n" } ] }, { "info": { "name": "Pipelines", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update a Pipeline", "type": "http" }, "http": { "method": "PUT", "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 update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a pipeline." } ] }, { "info": { "name": "Role", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update a Role", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/roles/:role_id", "params": [ { "name": "role_id", "value": "", "type": "path", "description": "The unique identifier of the role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Edit a role. Can only be used with application keys belonging to administrators." } ] }, { "info": { "name": "Permissions", "type": "folder" }, "items": [ { "info": { "name": "Datadog Revoke Permission", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/roles/:role_id/permissions", "params": [ { "name": "role_id", "value": "", "type": "path", "description": "The unique identifier of the role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Removes a permission from a role." }, { "info": { "name": "Datadog Update Permission Setting for Team", "type": "http" }, "http": { "method": "PUT", "url": "https://{subdomain}.{site}/api/v2/team/:team_id/permission-settings/:action", "params": [ { "name": "team_id", "value": "abc-123-def", "type": "path", "description": "None" }, { "name": "action", "value": "example_value", "type": "path", "description": "None" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update a team permission setting for a given team." } ] }, { "info": { "name": "Remove", "type": "folder" }, "items": [ { "info": { "name": "Datadog Remove a User from a Role", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/roles/:role_id/users", "params": [ { "name": "role_id", "value": "", "type": "path", "description": "The unique identifier of the role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Removes a user from a role." }, { "info": { "name": "Datadog Remove a Team", "type": "http" }, "http": { "method": "DELETE", "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": "Remove a team using the team's `id`." }, { "info": { "name": "Datadog Remove a User from a Team", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/team/:team_id/memberships/:user_id", "params": [ { "name": "team_id", "value": "abc-123-def", "type": "path", "description": "None" }, { "name": "user_id", "value": "abc-123-def", "type": "path", "description": "None" } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Remove a user from a team." } ] }, { "info": { "name": "Order", "type": "folder" }, "items": [ { "info": { "name": "Datadog Order Rum Retention Filters", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/rum/applications/:app_id/relationships/retention_filters", "params": [ { "name": "app_id", "value": "", "type": "path", "description": "RUM application ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Order RUM retention filters for a RUM application.\nReturns RUM retention filter objects without attributes from the request body when the request is successful." } ] }, { "info": { "name": "Upload", "type": "folder" }, "items": [ { "info": { "name": "Datadog Upload Idp Metadata", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/saml_configurations/idp_metadata", "body": { "type": "multipart-form", "data": [] } }, "docs": "Endpoint for uploading IdP metadata for SAML setup.\n\nUse this endpoint to upload or replace IdP metadata for SAML login configuration." } ] }, { "info": { "name": "Groups", "type": "folder" }, "items": [ { "info": { "name": "Datadog List Groups", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/scim/Groups", "params": [ { "name": "startIndex", "value": "1", "type": "query", "description": "Specifies the start index to fetch the results (1-indexed)." }, { "name": "count", "value": "20", "type": "query", "description": "Specifies the number of groups to be returned." }, { "name": "filter", "value": "example_value", "type": "query", "description": "Specifies the url encoded filter to use to narrow down the results.\nFilters can be in the form of `displayName eq ` or `externalId eq `\nor `id eq and members eq ` or `members eq and id eq `." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List groups in the organization.\nResults are paginated by `startIndex` and `count` parameters.\nResults can be narrowed down by the `filter` parameter." }, { "info": { "name": "Datadog Update Group", "type": "http" }, "http": { "method": "PUT", "url": "https://{subdomain}.{site}/api/v2/scim/Groups/:group_id", "params": [ { "name": "group_id", "value": "abc-123-def", "type": "path", "description": "None" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update the group with the given `group_id`." }, { "info": { "name": "Datadog Patch Group", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/scim/Groups/:group_id", "params": [ { "name": "group_id", "value": "abc-123-def", "type": "path", "description": "None" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch the group with the given `group_id`." }, { "info": { "name": "Datadog List Scanning Groups", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/sensitive-data-scanner/config" }, "docs": "List all the Scanning groups in your organization." }, { "info": { "name": "Datadog Reorder Groups", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/sensitive-data-scanner/config", "body": { "type": "json", "data": "{}" } }, "docs": "Reorder the list of groups." }, { "info": { "name": "Datadog Update Scanning Group", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/sensitive-data-scanner/config/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "The ID of a group of rules." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a group, including the order of the rules.\nRules within the group are reordered by including a rules relationship. If the rules\nrelationship is present, its data section MUST contain linkages for all of the rules\ncurrently in the group, and MUST NOT contain any others." } ] }, { "info": { "name": "Patch", "type": "folder" }, "items": [ { "info": { "name": "Datadog Patch User", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/scim/Users/:user_uuid", "params": [ { "name": "user_uuid", "value": "abc-123-def", "type": "path", "description": "None" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch the user with the given `user_uuid`." }, { "info": { "name": "Datadog Patch a Signal-based Notification Rule", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Partially update the notification rule. All fields are optional; if a field is not provided, it is not updated." }, { "info": { "name": "Datadog Patch a Vulnerability-based Notification Rule", "type": "http" }, "http": { "method": "PATCH", "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Partially update the notification rule. All fields are optional; if a field is not provided, it is not updated." } ] }, { "info": { "name": "Rules", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update a Suppression Rule", "type": "http" }, "http": { "method": "PATCH", "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" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update a specific suppression rule." }, { "info": { "name": "Datadog Test a Rule", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/rules/test", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Test a rule." }, { "info": { "name": "Datadog Update Scanning Rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/sensitive-data-scanner/config/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path", "description": "The ID of the rule." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a scanning rule.\nThe request body MUST NOT include a standard_pattern relationship, as that relationship\nis non-editable. Trying to edit the regex attribute of a rule with a standard_pattern\nrelationship will also result in an error." } ] }, { "info": { "name": "Convert", "type": "folder" }, "items": [ { "info": { "name": "Datadog Convert a Rule from Json to Terraform", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/rules/convert", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Convert a rule that doesn't (yet) exist from JSON to Terraform for datadog provider\nresource datadog_security_monitoring_rule." }, { "info": { "name": "Datadog Convert an Existing Rule from Json to Terraform", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/rules/:rule_id/convert", "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": "Convert an existing rule from JSON to Terraform for datadog provider\nresource datadog_security_monitoring_rule." }, { "info": { "name": "Datadog Convert a Job Result to a Signal", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/siem-historical-detections/jobs/signal_convert", "body": { "type": "json", "data": "{}" } }, "docs": "Convert a job result to a signal." } ] }, { "info": { "name": "Detection", "type": "folder" }, "items": [ { "info": { "name": "Datadog Validate a Detection Rule", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/rules/validation", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Validate a detection rule." } ] }, { "info": { "name": "Assignee", "type": "folder" }, "items": [ { "info": { "name": "Datadog Modify the Triage Assignee of a Security Signal", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/signals/:signal_id/assignee", "params": [ { "name": "signal_id", "value": "", "type": "path", "description": "The ID of the signal." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the triage assignee of a security signal." } ] }, { "info": { "name": "Change", "type": "folder" }, "items": [ { "info": { "name": "Datadog Change the Related Incidents of a Security Signal", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/signals/:signal_id/incidents", "params": [ { "name": "signal_id", "value": "", "type": "path", "description": "The ID of the signal." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the related incidents for a security signal." }, { "info": { "name": "Datadog Change the Triage State of a Security Signal", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/security_monitoring/signals/:signal_id/state", "params": [ { "name": "signal_id", "value": "", "type": "path", "description": "The ID of the signal." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the triage state of a security signal." } ] }, { "info": { "name": "Definition", "type": "folder" }, "items": [ { "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 Delete a Single Service Definition", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/services/definitions/:service_name", "params": [ { "name": "service_name", "value": "", "type": "path", "description": "The name of the service." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Delete a single service definition in the Datadog Service Catalog." } ] }, { "info": { "name": "Historical", "type": "folder" }, "items": [ { "info": { "name": "Datadog List Historical Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/siem-historical-detections/jobs", "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 order of the jobs in results." }, { "name": "filter[query]", "value": "security:attack status:high", "type": "query", "description": "Query used to filter items from the fetched list." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List historical jobs." }, { "info": { "name": "Datadog Run a Historical Job", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/siem-historical-detections/jobs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Run a historical job." } ] }, { "info": { "name": "Cap", "type": "folder" }, "items": [ { "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 Save New Value for On-demand Concurrency Cap", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/synthetics/settings/on_demand_concurrency_cap", "body": { "type": "json", "data": "{}" } }, "docs": "Save new value for on-demand concurrency cap." } ] }, { "info": { "name": "Teams", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update a Team", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/team/:team_id", "params": [ { "name": "team_id", "value": "abc-123-def", "type": "path", "description": "None" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update a team using the team's `id`.\nIf the `team_links` relationship is present, the associated links are updated to be in the order they appear in the array, and any existing team links not present are removed." } ] }, { "info": { "name": "Link", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update a Team Link", "type": "http" }, "http": { "method": "PATCH", "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" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update a team link." }, { "info": { "name": "Datadog Remove a Team Link", "type": "http" }, "http": { "method": "DELETE", "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": "Remove a link from a team." } ] }, { "info": { "name": "Attributes", "type": "folder" }, "items": [ { "info": { "name": "Datadog Update a User's Membership Attributes on a Team", "type": "http" }, "http": { "method": "PATCH", "url": "https://{subdomain}.{site}/api/v2/team/:team_id/memberships/:user_id", "params": [ { "name": "team_id", "value": "abc-123-def", "type": "path", "description": "None" }, { "name": "user_id", "value": "abc-123-def", "type": "path", "description": "None" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Update a user's membership attributes on a team." } ] }, { "info": { "name": "Billing", "type": "folder" }, "items": [ { "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": "Family", "type": "folder" }, "items": [ { "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": "Emails", "type": "folder" }, "items": [ { "info": { "name": "Datadog Send Invitation Emails", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/user_invitations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Sends emails to one or more users inviting them to join the organization." } ] }, { "info": { "name": "Disables", "type": "folder" }, "items": [ { "info": { "name": "Datadog Disable a User", "type": "http" }, "http": { "method": "DELETE", "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": "Disable a user. Can only be used with an application key belonging\nto an administrator user." } ] }, { "info": { "name": "Instances", "type": "folder" }, "items": [ { "info": { "name": "Datadog List Workflow Instances", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/workflows/:workflow_id/instances", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The ID of the workflow." }, { "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." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List all instances of a given workflow. This API requires an application key scoped with the workflows_read permission." } ] }, { "info": { "name": "Execute", "type": "folder" }, "items": [ { "info": { "name": "Datadog Execute a Workflow", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/workflows/:workflow_id/instances", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The ID of the workflow." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Execute the given workflow. This API requires an application key scoped with the workflows_run permission." } ] } ], "bundled": true }