{ "opencollection": "1.0.0", "info": { "name": "Datadog Account Lists API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "items": [ { "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 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 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 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 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 a List of Entities", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/catalog/entity", "params": [ { "name": "page[offset]", "value": "", "type": "query", "description": "Specific offset to use as the beginning of the returned page." }, { "name": "page[limit]", "value": "100", "type": "query", "description": "Maximum number of entities in the response." }, { "name": "filter[id]", "value": "", "type": "query", "description": "Filter entities by UUID." }, { "name": "filter[ref]", "value": "service:shopping-cart", "type": "query", "description": "Filter entities by reference" }, { "name": "filter[name]", "value": "", "type": "query", "description": "Filter entities by name." }, { "name": "filter[kind]", "value": "", "type": "query", "description": "Filter entities by kind." }, { "name": "filter[owner]", "value": "", "type": "query", "description": "Filter entities by owner." }, { "name": "filter[relation][type]", "value": "", "type": "query", "description": "Filter entities by relation type." }, { "name": "filter[exclude_snapshot]", "value": "", "type": "query", "description": "Filter entities by excluding snapshotted entities." }, { "name": "include", "value": "", "type": "query", "description": "Include relationship data." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a list of entities from Software Catalog." }, { "info": { "name": "Datadog Get a List of Entity Relations", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/catalog/relation", "params": [ { "name": "page[offset]", "value": "", "type": "query", "description": "Specific offset to use as the beginning of the returned page." }, { "name": "page[limit]", "value": "100", "type": "query", "description": "Maximum number of relations in the response." }, { "name": "filter[type]", "value": "", "type": "query", "description": "Filter relations by type." }, { "name": "filter[from_ref]", "value": "service:shopping-cart", "type": "query", "description": "Filter relations by the reference of the first entity in the relation." }, { "name": "filter[to_ref]", "value": "service:shopping-cart", "type": "query", "description": "Filter relations by the reference of the second entity in the relation." }, { "name": "include", "value": "", "type": "query", "description": "Include relationship data." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get a list of entity relations from Software Catalog." }, { "info": { "name": "Datadog Get a List of Pipelines Events", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/ci/pipelines/events", "params": [ { "name": "filter[query]", "value": "@ci.provider.name:github @ci.pipeline.name:Pull Request Labeler", "type": "query", "description": "Search query following log syntax." }, { "name": "filter[from]", "value": "2019-01-02T09:42:36.320Z", "type": "query", "description": "Minimum timestamp for requested events." }, { "name": "filter[to]", "value": "2019-01-03T09:42:36.320Z", "type": "query", "description": "Maximum timestamp for requested events." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of events in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of events in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to see your latest pipeline events." }, { "info": { "name": "Datadog Get a List of Tests Events", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/ci/tests/events", "params": [ { "name": "filter[query]", "value": "@test.name:test_foo @test.suite:github.com/DataDog/dd-go/model", "type": "query", "description": "Search query following log syntax." }, { "name": "filter[from]", "value": "2019-01-02T09:42:36.320Z", "type": "query", "description": "Minimum timestamp for requested events." }, { "name": "filter[to]", "value": "2019-01-03T09:42:36.320Z", "type": "query", "description": "Maximum timestamp for requested events." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of events in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of events in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List endpoint returns CI Visibility test events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to see your latest test events." }, { "info": { "name": "Datadog 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 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 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 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": "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 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 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 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": "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 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 List of Events", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/events", "params": [ { "name": "filter[query]", "value": "avg:system.cpu.user{*}", "type": "query", "description": "Search query following events syntax." }, { "name": "filter[from]", "value": "example_value", "type": "query", "description": "Minimum timestamp for requested events, in milliseconds." }, { "name": "filter[to]", "value": "example_value", "type": "query", "description": "Maximum timestamp for requested events, in milliseconds." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of events in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of events in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List endpoint returns events that match an events search query.\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to see your latest events." }, { "info": { "name": "Datadog Get a List of Incidents", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/incidents", "params": [ { "name": "include", "value": "", "type": "query", "description": "Specifies which types of related objects should be included in the response." }, { "name": "page[size]", "value": "", "type": "query", "description": "Size for a given page. The maximum allowed value is 100." }, { "name": "page[offset]", "value": "", "type": "query", "description": "Specific offset to use as the beginning of the returned page." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all incidents for the user's organization." }, { "info": { "name": "Datadog Get a List of Incident Types", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/incidents/config/types", "params": [ { "name": "include_deleted", "value": "", "type": "query", "description": "Include deleted incident types in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all incident types." }, { "info": { "name": "Datadog Get a List of Attachments", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/incidents/:incident_id/attachments", "params": [ { "name": "incident_id", "value": "", "type": "path", "description": "The UUID of the incident." }, { "name": "include", "value": "", "type": "query", "description": "Specifies which types of related objects are included in the response." }, { "name": "filter[attachment_type]", "value": "", "type": "query", "description": "Specifies which types of attachments are included in the response." } ] }, "docs": "Get all attachments for a given incident." }, { "info": { "name": "Datadog Get a List of an Incident's Integration Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/incidents/:incident_id/relationships/integrations", "params": [ { "name": "incident_id", "value": "", "type": "path", "description": "The UUID of the incident." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get all integration metadata for an incident." }, { "info": { "name": "Datadog Get 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 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 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": "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 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 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 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 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 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 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 Okta Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/integrations/okta/accounts" }, "docs": "List Okta accounts." }, { "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 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 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 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 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 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 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 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 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 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 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": "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 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 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 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 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 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 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 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": "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 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 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 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 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 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 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": "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 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 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 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 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": "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." } ] } ], "bundled": true }